integração com swagger-ui

Author: ssousa97

README.md

@@ -20,5 +20,5 @@
 - salvar cpf sem pontuação e retornar com pontuação [ok]
 - inserir filtro por bairro em /endereco (GET) [ok]
 - usar typeORM [ok]
-- usar docker [ToDo]
+- usar docker [ok]
 

package-lock.json

@@ -24,12 +24,14 @@
     "@nestjs/common": "^7.0.0",
     "@nestjs/core": "^7.0.0",
     "@nestjs/platform-express": "^7.0.0",
+    "@nestjs/swagger": "^4.6.1",
     "@nestjs/typeorm": "^7.1.4",
     "pg": "^8.4.0",
     "postgres": "^1.0.2",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
     "rxjs": "^6.5.4",
+    "swagger-ui-express": "^4.1.4",
     "typeorm": "^0.2.28"
   },
   "devDependencies": {

package.json

@@ -1,4 +1,5 @@
 import { Body, Controller, Get, Param, Post, Put } from '@nestjs/common';
+import { ApiParam, ApiProperty, ApiResponse } from '@nestjs/swagger';
 import { Endereco } from 'src/endereco/endereco';
 import { Aluno } from './aluno';
 import { AlunoService } from './aluno.service';
@@ -9,16 +10,19 @@ export class AlunoController {
     constructor(private alunoService : AlunoService){}
 
     @Post()
-    async criar(@Body() aluno : Aluno, @Body() endereco : Endereco) {
-        return await this.alunoService.criarAluno(aluno, endereco);
+    @ApiResponse({description : "True ou False, dependendo se foi inserido ou não"})
+    async criar(@Body() aluno : Aluno) {
+        return await this.alunoService.criarAluno(aluno);
     }
 
     @Put(':id')
+    @ApiResponse({description : "True ou False, dependendo se foi inserido ou não"})
     async atualizar(@Param('id') id : number, @Body() aluno : Aluno){
         return await this.alunoService.atualizarAluno(id, aluno);
     }
 
     @Get(':id')
+    @ApiResponse({description : "Retorna o aluno, caso não exista retorna false.\n Se o parametro for 'media' retorna os alunos cuja nota é maior que a media de todos os alunos"})
     async getPorId(@Param('id') id : number){
         if(id.toString() === 'media'){
             return await this.alunoService.getAlunosPorMedia();
@@ -27,16 +31,19 @@ export class AlunoController {
     }
 
     @Get()
+    @ApiResponse({description : "Retorna a lista de alunos, caso de errado retorna false"})
     async getTodos(){
         return await this.alunoService.getAlunos();
     }
 
     @Get(':id/endereco')
+    @ApiResponse({description : "Retorna os endereços de um aluno"})
     async getEnderecos(@Param('id') id : number){
         return await this.alunoService.getAlunoEnderecos(id);
     }
 
     @Get('/:nota/criterio/:criterio')
+    @ApiResponse({description : "Retorna os alunos cuja nota é maior ou menor que o critério passado"})
     async getPorNota(@Param('nota') nota : number, @Param('criterio') criterio : string){      
         return await this.alunoService.getAlunosPorNota(nota, criterio);
     }

src/aluno/aluno.controller.ts

@@ -1,4 +1,5 @@
 import { Injectable } from '@nestjs/common';
+import { ApiOperation, ApiProperty, ApiResponse } from '@nestjs/swagger';
 import { InjectRepository } from '@nestjs/typeorm';
 import { connectableObservableDescriptor } from 'rxjs/internal/observable/ConnectableObservable';
 import { Endereco } from 'src/endereco/endereco';
@@ -16,8 +17,8 @@ export class AlunoService {
         @InjectRepository(EnderecoEntity)
         private enderecoRepository : Repository<EnderecoEntity>){}
 
-
-    async criarAluno(aluno: Aluno, endereco : Endereco){
+    
+    async criarAluno(aluno: Aluno){
         try{
             if(! await this.alunoRepository.findOne({CPF : aluno.CPF})){
                 if(!this.validarCPF(aluno.CPF.toString())) {
@@ -35,10 +36,10 @@ export class AlunoService {
 
                 await this.alunoRepository.save(novoAluno); 
 
-                novoEndereco.bairro = endereco.bairro;
-                novoEndereco.complemento = endereco.complemento;
-                novoEndereco.numero = endereco.numero;
-                novoEndereco.rua = endereco.rua;
+                novoEndereco.bairro = aluno.endereco.bairro;
+                novoEndereco.complemento = aluno.endereco.complemento;
+                novoEndereco.numero = aluno.endereco.numero;
+                novoEndereco.rua = aluno.endereco.rua;
                 novoEndereco.aluno = novoAluno;
 
                 await this.enderecoRepository.save(novoEndereco);
@@ -153,6 +154,7 @@ export class AlunoService {
 
     }
 
+    @ApiResponse({description : "Retorna os alunos cuja nota é maior que a média de todos os alunos"})
     async getAlunosPorMedia(){
         try{
 
@@ -181,7 +183,7 @@ export class AlunoService {
         }   
     }
 
-    formatarCPF(aluno : Aluno){
+    formatarCPF(aluno : AlunoEntity){
 
         aluno.CPF = `${aluno.CPF.substring(0,3)}.${aluno.CPF.substring(3,6)}.${aluno.CPF.substring(6,9)}-${aluno.CPF.substring(9,11)}`;
 

src/aluno/aluno.service.ts

@@ -1,8 +1,22 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { Endereco } from "src/endereco/endereco";
+
 export class Aluno{
     id: number;
+
+    @ApiProperty()
     nome : string;
+    
+    @ApiProperty()
     dataNascimento: Date;
+    
+    @ApiProperty()
     CPF: string;
+
+    @ApiProperty()
     nota: number;
+
+    @ApiProperty()
+    endereco : Endereco;
 
 }

src/aluno/aluno.ts

@@ -1,4 +1,5 @@
 import { Param, Controller, Get, Post, Body } from '@nestjs/common';
+import { ApiResponse } from '@nestjs/swagger';
 import { Endereco } from './endereco';
 import { EnderecoService } from './endereco.service';
 
@@ -9,16 +10,19 @@ export class EnderecoController {
 
 
     @Post()
+    @ApiResponse({description : "Retorna o endereço criado, caso contrário retorna false"})
     async create(@Body() endereco : Endereco){
         return await this.enderecoService.createEndereco(endereco);
     }
 
     @Get()
+    @ApiResponse({description : "Retorna todos os endereços "})
     async getEndereco(){
         return await this.enderecoService.getEnderecos();
     }
 
     @Get(':bairro')
+    @ApiResponse({description : "Retorna os endereços que pertecem a um bairro"})
     async getEnderecoPorBairro(@Param('bairro') bairro : string){
         return await this.enderecoService.getEnderecosPorBairro(bairro);
     }

src/endereco/endereco.controller.ts

@@ -1,8 +1,19 @@
+import { ApiProperty } from "@nestjs/swagger";
+
 export class Endereco{
     id: number;
+
+    @ApiProperty()
     rua: string;
+
+    @ApiProperty()
     numero: string;
+
+    @ApiProperty()
     complemento: string;
+
+    @ApiProperty()
     bairro: string;
+    
     alunoId: number;
 }

src/endereco/endereco.ts

@@ -1,8 +1,19 @@
 import { NestFactory } from '@nestjs/core';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { AppModule } from './app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+  const options = new DocumentBuilder()
+  .setTitle('Desafio Lemobs')
+  .setDescription('Descrição da API')
+  .setVersion('1.0')
+  .addTag('Alunos')
+  .build();
+
+  const document = SwaggerModule.createDocument(app,options);
+  SwaggerModule.setup('api',app, document);
+
   await app.listen(3000);
 }
 bootstrap();