feat: improve swagger docs

ladesa-ro · Feb 24, 2024 · 09f83ba · 09f83ba
1 parent be803c4
commit 09f83ba
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 11 deletions.
diff --git a/luna-backend/src/application/app.controller.ts b/luna-backend/src/application/app.controller.ts
@@ -1,11 +1,39 @@
 import { Controller, Get } from '@nestjs/common';
+import { ApiResponse, ApiTags } from '@nestjs/swagger';
 import { AppService } from './app.service';
 
+@ApiTags('SISGEA - API')
 @Controller()
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
   @Get()
+  @ApiResponse({
+    status: 200,
+    description: 'Olá, Mundo!',
+    schema: {
+      type: 'object',
+      properties: {
+        service: {
+          type: 'string',
+          enum: ['sisgea-luna-backend'],
+          description: 'O nome desta aplicação.',
+        },
+        status: {
+          type: 'string',
+          enum: ['up'],
+          description: 'Status desta aplicação.',
+        },
+        egg: {
+          type: 'string',
+          default: null,
+          description: 'Mensagem secreta que aparece em ocasiões específicas.',
+          nullable: true,
+        },
+      },
+      required: ['service', 'status'],
+    },
+  })
   getHello() {
     return this.appService.getHello();
   }

diff --git a/luna-backend/src/application/app.service.ts b/luna-backend/src/application/app.service.ts
@@ -15,6 +15,7 @@ export class AppService {
       return {
         service: 'sisgea-luna-backend',
         status: 'up',
+        egg: null,
       };
     }
   }

diff --git a/luna-backend/src/infrastructure/api-documentate/DtoOperation.ts b/luna-backend/src/infrastructure/api-documentate/DtoOperation.ts
@@ -62,9 +62,7 @@ export const DtoOperationFindAll = (options: IDtoOperationOptions) => {
 
     ApiResponse({
       status: 200,
-
       type: options.swagger.returnType,
-
       description: options.description ?? 'Lista os recursos cadastrados no sistema.',
     }),
   );

diff --git a/luna-backend/src/main.ts b/luna-backend/src/main.ts
@@ -15,6 +15,7 @@ async function bootstrap() {
   //
 
   const isProduction = environmentConfigService.getRuntimeIsProduction();
+  const isDevelopment = environmentConfigService.getRuntimeIsDevelopment();
 
   //
 
@@ -33,16 +34,20 @@ async function bootstrap() {
 
   //
 
-  const config = new DocumentBuilder()
-    .setTitle('SISGEA - Luna - API')
-    .setDescription('API para a consulta e manipulação de dados e procedimentos relacionados ao Sistema de Gestão Acadêmico.')
-    .setVersion('0.0')
-    .addServer('https://luna.sisgha.com/api/')
-    .addServer('http://localhost:3000/')
-    .addBearerAuth()
-    .build();
+  const config = new DocumentBuilder();
 
-  const document = SwaggerModule.createDocument(app, config);
+  config.setTitle('SISGEA - Luna - API');
+  config.setDescription('API para a consulta e manipulação de dados e procedimentos relacionados ao Sistema de Gestão Acadêmico.');
+  config.setVersion('0.0');
+
+  if (isDevelopment) {
+    config.addServer('http://localhost:3000/');
+  }
+
+  config.addServer('https://luna.sisgha.com/api/');
+  config.addBearerAuth();
+
+  const document = SwaggerModule.createDocument(app, config.build());
   SwaggerModule.setup('doc-api', app, document);
 
   //