Swagger (suas APIs documentadas sem esforço) // Dicionário do Programador

Documentar sistemas é e sempre será um desafio. Lembro bem que para fazer alterações grandes nos projetos, era preciso passar horas e mais horas atualizando diagramas, documentações técnicas e manuais de usuários. Ao longo dos anos as ferramentas foram se aperfeiçoando até que chegou o Swagger! Se você nunca usou, tenho certeza que sairá desse vídeo com uma outra visão sobre como documentar suas APIs.

📝 𝗟𝗶𝗻𝗸𝘀 𝗖𝗶𝘁𝗮𝗱𝗼𝘀

🎙️ Compilado Podcast

🤝 Roteiro em colaboração com Hebert Barros

🔗 Mais links do Código Fonte TV

#API #Rest #Swagger

[arozendojr]

Sugestão : Uma parte 2, seria usar Swagger web importando no postman

[robsonsilva]

Passei para deixar uma contribuição com relação ao swagger para Visual Studio 2019 e 2022 especificamente com desenvolvimento de apis c#:

Erro MSB3024:

1 - Acesse as propriedades de seu projeto
2 - "Flagueie" Gerar um arquivo correspondente a documentação da api
3 - Na opção Caminho do arquivo de documentação XML preencha com o nome do projeto da api.xml
4 - Na opção Caminho base da saída clique em "Procurar" e apenas (sim é ridículo assim mesmo) clique em Selecionar Pasta e selecione onde está o projeto da api
5 - Parabéns, você resolveu essa "mundiça" de erro!

Ps: CDFs, obrigado pelo conteúdo! Espero que vocês estejam bem pós os eventos daquela chuva que deu semanas atrás! Abraço!

[fernandocoelho]

A minha curiosidade ficou por conta de usar o Swagger, antes codar.
Um concorrente não citado, seria o Insomnia Docs.
Já se você usa o FastAPI, para gerar Endpoint, o nesmo possui Utilitários para lidar com a documentação automática da UI OpenAPI, incluindo Swagger UI (por padrão em /docs) e ReDoc (por padrão em /redoc).

[carlosaugusto.devjava]

Vocês são de mais. Falam sempre de TUDO, com muita qualidade. A galera de TI, tanto iniciante quanto senior que fica sempre revisando as coisas, todos nós precisamos muito de vocês.

[rotognin]

Muito legal!
Eu entrei em contato com o Swagger quando precisei fazer uma integração com um fornecedor.
Não fazia ideia que isso existia, até estranhei no início, mas depois vi o quanto facilita a nossa vida!
Eu poderia fazer testes para ver o retorno, os tipos de dados que os campos aceitavam, etc... Muito bacana!
Nunca fui com a cara do postman...
Valeu pessoas!

[MarcusBecker]

Precisei mexer com Swagger algumas semanas atrás, e para ter uma introdução, o primeiro lugar que procurei foi aqui. Que bom que esse vídeo saiu :)

[victormanhani]

Que sensacional! Acredito fortemente que o dicionário do programador poderia virar um ou mais livros com tanto conteúdos incríveis como este!!! E uma contribuição existe também umaa outra opção não Open Source do OpenAPI é o RAML, que significa Restfull API Modeling Language, que trata de modelagem de APIs com YAML de uma forma bem bacana também e é muito utilizado pela Mulesoft, empresa e produto bem forte no mundo da integração, vale a pena conferir!!! Muito obrigado misters do Código Fonte 🤩🤩

[danielfcollier]

Muito bom conhecer mais da história do Swagger! Senti falta de comentarem que evoluiu para o OpenAPI visto que hoje há vários recursos opensource com o nome e sponsor da OpenAPI. Também dá para usar no Docusaurus. Aqui na empresa fiz um gerador da spec a partir do código fonte em C#, quem sabe no futuro vira um projeto opensource, mas por enquanto boa parte é feita em Bash e AWK (o que complica a manutenção e portabilidade - vendo de migrar para Python). No final dá para juntar tudo e exportar via npm usando módulos para fazer o bundle e converter para Postman.

[gabrielm_dev]

Estou trabalhando com swagger num back end que tô fazendo em um sistema legado. Ótimo vídeo, esclareceu muita coisa!

[gabrielgoncalvesdossantos]

Ajudou demais, estou fazendo teste em um desafio onde preciso utilizar essa ferramento e nunca utilizei uma API...

[eduardosaatkamp]

Achei maravilhoso essa ferramenta, e o vídeo ajudou bastante, apresentando desde o que é, até como pode ser utilizada. ótimo conteúdo, valeu.

[cursophpecidade]

Vocês são sempre fantásticos! Parabéns!

[andersoncarlospiresmarinho]

Aprendi mais com esse canal do que na Faculdade kkkk

[raffaeleloi]

Muito bom !! Estava pesquisando sobre o swagger nesse final de semana.
Esse canal é incrível.

[alanalves]

Sugiro o episódio para a Linguagem Ruby.♥️💎

[romiso]

Eu uso o Talend API Tester, funciona como extensão do Chrome.

[sonysantos]

Gabriel: FROnt-End Staff (FROES); Vanessa: desenvolvedora WEB (WEBER). Vá nessa, Gabriel! 😄Parabéns pelo conteúdo! Sucesso ao casal!

[jairodyne]

Acho bem legal a integração do swagger com o Spring do Java via SpringFox e SpringDoc. Gostaria muito de integrar com aplicações Java que NÃO usam o Spring, apenas o JPA.

[MozartMartins]

Nao diria sem esforco. Quando utilizei Swagger com RSpec, foi muito trabalhoso.

[romiso]

E pra desenvolver API eu uso o Application Integration do Informatica Cloud.