Nodejs - Criando documentação com Swagger - Code/drops #85

Поделиться
HTML-код
  • Опубликовано: 6 ноя 2024

Комментарии • 112

  • @rodrigo.yokota
    @rodrigo.yokota 3 года назад +48

    Uma dica válida pra quem vai fazer documentação usando swagger com typescript é a lib openapi-types que possui tipagem replicando a estrutura do json do OpenAPi.
    Dessa forma consegue-se desenvolver a descrição com ajuda do auto-complete e em um objeto ts.

    • @Thalissamary
      @Thalissamary 2 года назад

      Você pode me ajudar sobre ? Quero incluir o swagger no ionic !

  • @StephenWillians
    @StephenWillians 3 года назад +5

    Muito massa, apliquei esse conhecimento no meu trabalho e ja documentei a maioria das rotas da API interna, parabens e obrigado 👏🏾👏🏾 👏🏾 🙏🏾

    • @rocketseat
      @rocketseat  3 года назад

      Faaaaala, Stephen!
      Sério? Que massa! Mandou muito! 👏‍🏻‍👏‍🏻‍👏‍🏻‍

  • @joaoapuamelo5899
    @joaoapuamelo5899 2 года назад +1

    Didática excelente e professora maravilhosa. Tirou muita onda e me ajudou muito. Fez parecer fácil usar o swagger e dá primeira vez que eu olhei a API fiquei desesperado hahah agora to achando fácil, muito obrigado!

  • @app2028
    @app2028 3 года назад +7

    Se e Rockeset nem precisa ver para deixar o Like vamos contribuir!
    Parabéns como sempre conteúdos de altíssima qualidade!

  • @ericnevesr
    @ericnevesr 3 года назад +2

    Dani tem um didática excelente!!!

  • @yurimarcon
    @yurimarcon 3 года назад +3

    Maano, que vídeo TOOPPP!!!!!
    Eu nunca tinha ouvido falar de Swagger, e nas últimas semanas ouço quase todos os clientes pedindo documentações em Swagger como padrão.
    Parabéns pelo conteúdo, e explicação top!!!

  • @diegosk4965
    @diegosk4965 2 года назад

    TNice tutorials is aweso! I was feeling kinda overwheld when i first start soft but after watcNice tutorialng your tutorial video, i feel much more confident

  • @arthsan-i8t
    @arthsan-i8t 3 года назад

    Estava justamente buscando tutoriais de como montar uma documentação usando swaggerUI há uma semana. Ainda não encontrei uma boa explicação para personalizar a interface gráfica e remover a identidade visual da marca swagger para substituir por outra. Obrigado pelo conteúdo!

  • @felipehuggler9557
    @felipehuggler9557 3 года назад +2

    Foooooooooooooooooooooooooooooooooooooooooooooda!!!! VC ARREBENTOU! ARREBENTOU! Mto foda mesmo!

    • @rocketseat
      @rocketseat  3 года назад

      VALEEEEU, Felipe! Dani arrebenta, né? 💜 😛
      Já tinha feito alguma documentação com o Swagger? 👀

  • @ronnycbo
    @ronnycbo Год назад

    Excepcional!! Completo, suficiente, importante, didática!! Parabéns!!

  • @RomuloSRamos
    @RomuloSRamos 3 года назад

    obrigado dani! dei uma estudada na doc do Swagger já a um tempo. pois é o utilizado na sandbox da API do banco do brasil e pela TOTVS na API do RM. Mas com a sua didática é outra coisa. acho que desta vez quem vou conseguir documentar minhas APIs do jeito certo

  • @LeDragoX
    @LeDragoX 3 года назад +5

    Parece uma forma bem interessante de documentar, é a minha primeira vez vendo na prática, um site prontinho (e funcional) com a documentação. Muito útil!

    • @rocketseat
      @rocketseat  3 года назад

      Faaaaala, dev!
      É bem prático, né? E o resultado fica incrível! 😍
      Se for usar, conta pra gente a experiência! 💜

  • @messiasspp
    @messiasspp 3 года назад +1

    Vivaldi Browser... Amo muito esse browser... Amei o Vídeo...

  • @cortaesai
    @cortaesai Год назад

    Papo 10. Fazer usando .yaml é muito massa. Com json senti que tava muito ruim de enxergar é muita chave muitas aspas. Usei a lib yamljs

  • @rosemayara9758
    @rosemayara9758 Год назад +1

    Meu que aulão!!! Meus parabéns 👏🤩

  • @vitoramorim6589
    @vitoramorim6589 3 года назад +1

    Assistindo na madruga, ótimo vídeo!

  • @raiomarco6
    @raiomarco6 3 года назад +33

    Uma sugestão interessante também, agora que falaram sobre o swagger, seria legal falar também do swagger autogen, que gera a doc do swagger de forma automática, que facilita bastante a criação da documentação, e evita aquele problema de esquecer de atualizar a doc né kk

    • @hallexcosta
      @hallexcosta 3 года назад

      @raiomarco ele consegue identificar as rotas de forma automatica e gerar uma documentação pronta?

    • @raiomarco6
      @raiomarco6 3 года назад +3

      @@hallexcosta sim, acaba ficando bem prático, e da pra incrementar a documentação com comentários na própria rota, aí fica bem mais tranquilo de documentar

    • @Fernando-du5uj
      @Fernando-du5uj 3 года назад +2

      Excelente dica! Obrigado!

    • @hallexcosta
      @hallexcosta 3 года назад +1

      @@raiomarco6 ainda não testei o swagger autogen mais quando eu precisar eu já sei que existe algo que facilita na hora de documentar a API, muito obrigado!

    • @DanielRios549
      @DanielRios549 2 года назад +1

      @@raiomarco6 Eu to usando o autogen, o que eu não gostei foi justamente essa forma de incrementar as informações da rota, comentários é difícil de escrever, não tem tipagem e tals, seria melhor se tivesse decorators ou qualquer outra coisa com tipagem pra facilitar. Mas enfim, já é melhor do que ter tudo separado no arquivo json...

  • @KaytoStormBrazil
    @KaytoStormBrazil 2 года назад

    It really worked for me after I look and try some tutorials, yours is the one that worked. Owe you a lot.

  • @paulorobertosallesdossanto6616
    @paulorobertosallesdossanto6616 2 года назад

    Te agradeço por disponibilizar seu tempo trazendo conteúdos que agregam conhecimentos relevantes. Parabéns!

  • @brunouemura2792
    @brunouemura2792 3 года назад +3

    Muito bom o timing kk, estava pesquisando isso ontem!

  • @josemarsilva
    @josemarsilva Год назад

    obrigado por disponibilizar conteúdo de qualidade

  • @litzdc1212
    @litzdc1212 3 года назад

    amo sua forma de explicar

  • @DouglasSantos-mq4jl
    @DouglasSantos-mq4jl Год назад

    Excelente conteúdo. Parabéns pela didática e disponibilidade.

  • @tiago.gcastro
    @tiago.gcastro 3 года назад +4

    Mas e se eu tiver rotas para user e diversas outras, eu continuaria escrevendo todas as rotas nesse unico arquivo ou criaria outros arquivos .json desse? Pq pensando em deixar a doc atualizada, talvez ficaria um processo chato em ter que procurar o local... risco de errar e tudo mais por ser muitas linhas.
    Muito top, não sabia disso. Só está duvida q me restou

  • @leandromedvedev
    @leandromedvedev 2 года назад +1

    Mais um excelente vídeo, Dani! Parabéns e obrigado. :)(:

  • @MrCastro1971br
    @MrCastro1971br 5 месяцев назад

    Faz um tutorial de como dar like no vídeo mais de 300 vezes!!! Super amei. Obrigadow

  • @jamesglitchofficial
    @jamesglitchofficial 2 года назад

    Parabéns pelo material!

  • @edufgh6266
    @edufgh6266 3 года назад +3

    rocketseat & Dani, vcs são demais ❤! mais um Code/drops foda!

  • @marcioalexandremarcondes557
    @marcioalexandremarcondes557 2 года назад

    Sensacional! Manja muito! Parabéns!

  • @crystynynha1
    @crystynynha1 3 года назад

    Que conteúdo massa! Já apliquei no projeto node que fizemos na NLW, valeu Dani.

  • @julianafreitas9658
    @julianafreitas9658 2 года назад

    Obrigada pelo conteudo, explicou de forma muito compreensiva e ajudou bastante

  • @sidneydev
    @sidneydev 3 года назад +3

    Ótimo conteúdo Dani!!! Teria alguma forma de estruturar separando de acordo com a categoria das rotas, ou usando os decorators, que vc citou no início do vídeo.

  • @PabloGeokar
    @PabloGeokar 3 года назад

    Muito boa esta sua explicação, já salvei este vídeo na minha playlist preferida, parabéns pelo conteúdo.

    • @rocketseat
      @rocketseat  3 года назад +1

      Faaaaala, Pablo!
      Poxa, que massa! Valeu demais pelo feedback! 💜

  • @henriquemoura1996
    @henriquemoura1996 3 года назад

    Gratidão por esse vídeo. Muita qualidade!!!!!!

    • @rocketseat
      @rocketseat  3 года назад

      Nós que agradecemos o feedback, Henrique! Que massa que te ajudamos de alguma forma! 💜 🚀

  • @gelzienyrezendemartins8248
    @gelzienyrezendemartins8248 3 года назад

    Dani muito, top.

    • @rocketseat
      @rocketseat  3 года назад

      Ela manda bem demais, né, Gelzieny? 💜 😍

  • @monjioilita
    @monjioilita 6 месяцев назад

    Pessoal, por favor eu gostaria que ainda esses dias voçês fizessem uma video aula sobre como fazer o deploy de uma API que utiliza o sqlite3 na Vercel pra que na Proxima semana eu venha a Poder já ter acesso a ela, é que estou mesmo com problemas quanto a issso e também a como após o deploy deixar o meu endpoint 100% visivel e as minhas rotas acessiveis atraves do dominio publico que a vercel nos disponibliza

  • @wrfRodrigues
    @wrfRodrigues 3 года назад

    Parabéns, ótimo conteúdo e didática.

  • @flavioeduardo5807
    @flavioeduardo5807 3 года назад

    É possível automatizar a documentação com o Joi, por exemplo? Aí ele identificaria as rotas e os parâmetros necessários para aquela requisição.
    Digo no sentido de automatizar, pois o .Net Core já possui swagger integrado e todas as rotas são automaticamente documentadas, sem ser necessário reescreve-las.
    Excelente vídeo!

  • @joaoeliandro2172
    @joaoeliandro2172 3 года назад

    Quando vai sair background job com TS até a produção?

  • @anacarolinamejia3839
    @anacarolinamejia3839 2 года назад

    I checked - everything is clean

  • @anothergamerbyjaman
    @anothergamerbyjaman Год назад

    Será que existe alguma extensão do swagger para o vscode para documentar isso mais rapido ou algo do tipo?

  • @SamantaFluture
    @SamantaFluture 3 года назад

    obrigada! ajudou muito! era tudo o que eu precisava!

    • @rocketseat
      @rocketseat  3 года назад

      Wooow! Que massa, Samanta! 💜 😍

    • @SamantaFluture
      @SamantaFluture 3 года назад

      @@rocketseat obrigada vcs!!

  • @fabioishizu3739
    @fabioishizu3739 3 года назад

    Muito obrigado por essa explicação ótima, me ajudou MUITO!!!!!! 😬

  • @CodeBuilderBrasil
    @CodeBuilderBrasil Год назад

    8:27 é onde começa de vdd rs

  • @andrerodrigues3322
    @andrerodrigues3322 2 года назад

    Muito bom! Obrigado :)

  • @EddyeBoyGamer
    @EddyeBoyGamer 2 года назад

    Tutorial extremamente necessário, exemplifica bem como criar o swagger com exemplo de api criada com funções. Eu encontrei na internet exemplos de geração automatica do swagger mas com a api toda baseada em classes. Tem alguma forma de fazer essa geração automática no mesmo exemplo de código que você criou?

  • @380wenyo
    @380wenyo 2 года назад

    Me ajudou de mais! Vlw

  • @antonioulundo5765
    @antonioulundo5765 3 года назад +2

    assistindo

  • @ads05dev20
    @ads05dev20 3 года назад

    top demais, muito obrigado

  • @danifreitas1662
    @danifreitas1662 2 года назад

    s. Thank you In The setup❤️

  • @rafaelmacedoferreirabassol5306
    @rafaelmacedoferreirabassol5306 2 года назад

    now i am in a good mood

  • @tetefinha1
    @tetefinha1 2 года назад

    Even once you understand how to use soft soft, having the ear to make a good soft is a whole different story

  • @michaellourenco2106
    @michaellourenco2106 3 года назад

    Sensacional!

    • @rocketseat
      @rocketseat  3 года назад

      Que massa que curtiu, Michael! 💜

  • @JativeMoney
    @JativeMoney 2 года назад

    God, I'm glad I found your video that helped me

  • @Thim.23
    @Thim.23 2 года назад

    i finally made so good soft. thanks ❤

  • @mlapdj
    @mlapdj 2 года назад

    Thank youuu so much!!!

  • @pl1a5grupo53
    @pl1a5grupo53 2 года назад

    mt bom!

  • @g-laveli
    @g-laveli 2 года назад

    Qual é o nome da extenção para deixar os colchetes coloridos ? eu peguei uma vez mas esqueci.

  • @ANONIMUism
    @ANONIMUism 3 года назад

    Tem como fazer um Authentication via headers?

  • @williangomes3892
    @williangomes3892 3 года назад

    Linda amei está moça 💗

  • @2016Trabalhosonline
    @2016Trabalhosonline 3 года назад

    kr muito top!

    • @rocketseat
      @rocketseat  3 года назад

      Que massa que curtiu! 💜 😍

  • @gutemberguemascarenhas7890
    @gutemberguemascarenhas7890 3 года назад

    Excelente tutorial!

    • @rocketseat
      @rocketseat  3 года назад +1

      Faaaaala, Gutembergue! Que massa que curtiu! 💜
      Já tinha mexido com Swagger antes? 😛

    • @gutemberguemascarenhas7890
      @gutemberguemascarenhas7890 3 года назад

      @@rocketseat já tinha utilisado antes mas com o editor do swagger, ela tem uma excelente didática, gostaria muito de ver mais tutoriais como esse se possível de testes no Node, Obrigado a todos vcs

  • @aureliomoreira8412
    @aureliomoreira8412 3 года назад

    Muito bom!

    • @rocketseat
      @rocketseat  3 года назад

      Que show que curtiu, Aurélio! 💜 🚀

  • @deividborges8618
    @deividborges8618 2 года назад

    27:50 fiquei com dúvida quando eu tenho na mesma rota mais de uma mensagem para o mesmo código de erro. No cao d euma rota de login. tenho email e password. caso n mande o email retorna email incorrect e se for password retorna password incorrect. Como faria dai?

  • @viniciussantana8223
    @viniciussantana8223 2 года назад

    I can't afforded soft soft. what alternative can I get?

  • @limaand2009
    @limaand2009 2 года назад

    é free ?

  • @leandrofreitas4566
    @leandrofreitas4566 2 года назад

    AMAZING

  • @mardoniomelo4783
    @mardoniomelo4783 3 года назад

    Show!

  •  2 года назад

    boaaaa

  • @mlapdj
    @mlapdj 2 года назад

    Wanted to thank you for a great vid. Helped a lot. I've been trying to get going in both soft soft and didn't get very far. TNice tutorials vid helped a

  • @patriciabrito_mg
    @patriciabrito_mg Год назад

    show

  • @beyondthestoryco
    @beyondthestoryco 2 года назад

    ikr too. i clicked on sotNice tutorialng and now i cant find any tracks and everytNice tutorialng is blank idk what to do

  • @dotkoon
    @dotkoon 3 года назад

    Que extensão é essa, que muda a cor das chaves?

    • @dotkoon
      @dotkoon 3 года назад +1

      Encontrei, se chama Bracket Pair Colorizer

  • @demostenesbr
    @demostenesbr 4 месяца назад

    Update: a biblioteca uuid deve ser declarada agora como: import { v4 as uuidv4 } from 'uuid';

  • @vulgoglzinn8509
    @vulgoglzinn8509 2 года назад

    sotNice tutorialng in the soft roll and the soft outgrows the length of the step sequencer. it's not obvious how to "shrink" the soft rolled

  • @tiberiolima
    @tiberiolima 3 года назад

    Show

  • @viniciusmarsola4126
    @viniciusmarsola4126 Год назад

    alguém conseguiu fazer com o fastify ?

  • @jeffersonlima1442
    @jeffersonlima1442 2 года назад

    placent, effective EQing, compression, and recording live soft in general... but none of them explained the sequencer, and how

  • @joaovictordamasceno9006
    @joaovictordamasceno9006 3 года назад

    Alguém sabe me dizer como faz pra esconder a área de Schemas? no caso eu estou usando no Java com spring.

  • @higorrocha9470
    @higorrocha9470 3 года назад

    Aposto que era a PagSeguro que ela penou. kkkkkk Já passei maus bocados com ela! :(

    •  3 года назад

      Quem dera fosse ahahah... Acho que da PagSeguro era melhor ainda rsrs

  • @brunosantosmartins6136
    @brunosantosmartins6136 3 года назад

    e quando for params.

  • @viniciussantana8223
    @viniciussantana8223 2 года назад

    Make a 1 hour video of one nice tuto from google

  • @benttzbenttz773
    @benttzbenttz773 2 года назад

    +sub

  • @vbpesca
    @vbpesca 2 года назад

    how to improve my attention span , I have good ideas and soft that I tNice tutorialnk up , the problem is putting it down in fruit loops and knowing

  • @firemartins
    @firemartins 2 года назад

    "Welco-"

  • @ianyamaguchi8515
    @ianyamaguchi8515 2 года назад

    im the 300th lol

  • @mlapdj
    @mlapdj 2 года назад

    .

  • @hxl5939
    @hxl5939 2 года назад

    - 10 secs

  • @luiggiabdiel9345
    @luiggiabdiel9345 Год назад

    Muito bom!