Instalar Swagger en NestJS

Hola a todos, explicamos como instalar Swagger en NestJS.

Swagger es una herramienta que nos permite documentar nuestros endpoints.

Sino tienes creado un proyecto en NestJS, te dejo un tutorial sobre ello:

Como crear un proyecto con NestJS

Necesitamos instalar las siguientes dependencias:

$ npm install --save @nestjs/swagger swagger-ui-express

Todo esto lo tienes en la documentación oficial de nestjs, aquí lo puedes ver.

En el fichero main.ts, colocaremos el siguiente código:

const config = new DocumentBuilder()
  .setTitle('Swagger example')
  .setDescription('Description')
  .setVersion('1.0')
  .build();
const document = SwaggerModule.createDocument(app, config);
SwaggerModule.setup('api', app, document);

Recuerda de añadir estas importaciones:

import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';

Quedando así:

Si arrancamos nuestro proyecto y ponemos en el navegador http://localhost:3000/api

Solo tenemos un endpoint, que es de por defecto que esta situado app.controller.

Vamos a añadir un par de cosas en el app.controller, tenemos una cantidad de decoradores muy útiles.

@ApiTags es un decorador para cambiar el nombre del grupo.

@ApiOperation es un decorador para mostrar una descripción de que hace el endpoint.

Recuerda que podemos probar el resultado de nuestros endpoints, pulsando en «Try it out».

Si le damos execute, veremos el resultado.

Tienes todos los decoradores en la página oficial de nestjs aquí.

Espero que os sea de ayuda. Si tenéis dudas, preguntad. Estamos para ayudarte.

Compartir

Deja una respuesta

Tu dirección de correo electrónico no será publicada.