Node.js / NestJS

Documentação de API e contratos

Swagger, OpenAPI, versionamento, documentação por versão, Postman, coleções, contratos de API

20 perguntas de entrevista·
Junior
1

O que é o Swagger no contexto do NestJS?

Resposta

O Swagger é uma ferramenta que gera automaticamente documentação interativa de API REST analisando os decorators do NestJS. Essa documentação permite visualizar e testar os endpoints diretamente de uma interface web acessível via /api. É necessário instalar o pacote @nestjs/swagger e configurar o SwaggerModule no main.ts para usá-lo.

2

Qual pacote instalar para usar o Swagger no NestJS?

Resposta

O pacote @nestjs/swagger é a biblioteca oficial para integrar o Swagger em uma aplicação NestJS. Também é necessário instalar o swagger-ui-express, que fornece a interface web interativa. Esses dois pacotes trabalham juntos para gerar a documentação OpenAPI e exibi-la no navegador.

3

Onde configurar o SwaggerModule em uma aplicação NestJS?

Resposta

O SwaggerModule é configurado no arquivo main.ts depois de criar a aplicação NestJS com NestFactory.create(). O método SwaggerModule.setup() recebe três parâmetros: o caminho da documentação, a instância da aplicação e o documento gerado por createDocument(). Essa configuração deve ser feita antes do app.listen() para que a documentação fique acessível na inicialização.

4

Qual é o papel do decorator @ApiTags()?

5

O que é OpenAPI?

+17 perguntas de entrevista

Domine Node.js / NestJS para sua proxima entrevista

Acesse todas as perguntas, flashcards, testes tecnicos, exercicios de code review e simuladores de entrevista.

Comece gratis