NestJS - Documentação automática com Swagger

Nunca foi tão fácil gerar uma documentação automática de endpoints, permitindo um potencial de expansão gigantesco, definindo a estrutura de cada entidade e deixando o nosso backend muito mais comunicativo!

Repositório no GitHub (com arquivo de passo a passo):

····················································································

● Marcas de Tempo:

00:00 - Intro
00:19 - Apresentação do documento
01:32 - Rodando o projeto Nest
02:38 - Instalando o Swagger
03:58 - Configurando o Swagger
04:54 - Testando o Swagger
06:01 - Conectando os Endpoints
07:15 - Organizando os Endpoints
08:20 - Testando as requisições
08:54 - Deixando o backend mais declarativo
13:55 - Melhorando a declaração com comentários
19:30 - Recados Finais
21:15 - Encerramento

····················································································

● Linhas de Comando:

nest new nestjs-documentacao-swagger-video

npm run start:dev

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

····················································································

● Links Utilizados

Documentação Open API (Swagger):

····················································································

Se inscreva no canal e ative o sininho para não perder os próximos vídeos.

Paulo Salvatore

Fábrica de Sinapse

····················································································

► Todo o conteúdo criado por mim aqui no YouTube é 100% gratuito. Acredito que a educação deve estar disponível gratuitamente para todos e todas.

[rodrigovieirabatistadossan]

Você tem uma das melhores didáticas que já vi no meio da programação! Parabéns!!

[gmoreirasouza]

Parabéns, Muito bom.
A sua didática pra ensinar é ótima.

Me ajudou demais.

[leandrolima]

Excelente conteúdo, prof. Salvatore! Ótimas explicações como sempre, parabéns pela didática!

[ArseniumGX]

Excelente conteúdo, Paulo. Vou começar a implementar em todos os projetos que faço.

[caiqlima]

Cara muito bom, realmente muito boa sua didática.

[cassiojosejesus]

Cara fantástico.
Você explica muito, mas muito bem.

[ercioalendre]

Parabéns pela aula sensacional, Paulo!

[vladimir-costa]

Gostei muito do vídeo. Só ficou faltando como faço para colocar a autenticação, vão existir rotas que precisam ser autenticadas, como faço para aplicar isso?

[SimpleKOD]

Excelente, bem mais rápido que criar o json na mão, mas é a base, em breve mudo para nestjs. Na luta pra mudar de área e a forma como prepara a aula fica muito bom para aprender, obrigado pelo conhecimento e dedicação.

[RogerBaracySantos]

Excelente video 😀
Muito obrigado por disponibilizar esse conteúdo.

[gilbertopsantosjr]

muito bom, so faltou usar o Header the Authorization, dai ficava super.

[bellmontsistema]

Salvou, Vlw.
ganhou mais um inscrito .

[yurisilva]

Top o vídeo. Eu cheguei aqui procurando como faz a autenticação com bearer token, já li a documentação mas ainda não consegui implementar. Não achei nenhum vídeo em portugues ainda, acho que seria um tema legal pra vc falar em outro vídeo amigo.

[cassiojosejesus]

Paulo,

Usando o recurso "introspectComments", para não usar os decorator, facilita muito a documentação da API.

Mas tenh uma dúvida:

Vamos supor que tenha um recuso da API, que eu não queira deixar disponível no Swager. tem com oocultá-la?

[erickeft]

Opa Paulo, valeu pelo conteudo!!! Uma dúvida: voce sabe alguma forma de inserir um form de autenticação na api do swagger, de forma que o user pudesse se logar lá e fosse gerado o token jwt pra ser preenchido automaticamente? Se souber como fazer ou souber me indicar alguma direção, agradeço!!

[devitosolucoes]

Gostei do vídeo. Gostaria de saber se você poderia tirar uma dúvida aqui? Nas responses que o swagger me trás de forma automática, ela expande todos os relacionamentos da model que eu estou retornando... E ela expande infinitamente. Existe uma maneira de evitar isso? Sem ter que ir controller por controller e colocar uma response pra cada uma?

[erlonpb]

Excelente vídeo, Paulo!

Até o momento sei apenas trabalhar com express, tenho pouco conhecimento na área, mas queria fazer umas perguntas sobre isso.
O recomendável então é criar esse boilerplate antes de desenvolver/criar os endpoints ou dá pra fazer (sem muita dor de cabeça) o caminho contrário?

Eu apreendi swagger da pior maneira e acabei fazendo tudo manualmente, foi bem complicado.

Também queria perguntar se existe um pacote semelhante ou até igual pra trabalhar com express, ou talvez nem faça diferença?
Parabéns mais uma vez pelo vídeo, foi muito didático!

[danielfonsecadasilva]

Top usando no meu projeto '-'

[antoniofernandes]

o meu aparece o erro No operations defined in spec!

[jgbrandao]

A quantidade de conteúdo sobre NestJS em português é escassa. Obrigado.