Documentação: Swagger ou OpenAPI?

Na terceira parte da saga documentação, vou falar um pouco sobre Swagger e OpenAPI. Sendo bem direto, quando precisamos documentar uma API, usamos o Swagger para facilitar nossa vida. Além de documentar, o Swagger possibilitar usar outras ferramentas para auxiliar na geração de código, usar o formato json para criar sua documentação entre outros. Além disso, o Swagge possui um padrão de documentação. Além da versão gratuita, o Swagger conta com versões pagas com foco para empresas. Partindo para o OpenAPI, é importante entender que o OpenAPI é um padrão que podemos utilizar para fazer a documentação da API e até mesmo participar do projeto com sugestões de boas praticas. Perceba que por se tratar de um padrão, você pode usar o Swagger para gerar sua documentação com o padrão OpenAPI.

Bem, no meu dia a dia, eu uso o Swagger não só para documentação como para geração de código e também para segurança da API. Isso é interessante, pois para empresas o Swagger gera um ganho de produtividade bem grande. Para ser ter uma ideia, criar um projeto do zero no meu serviço é muito mais rápido do que eu pegar um projeto base nos sites do Micronaut ou Spring Boot. Uma observação, não é só o Swagger, eu também uso um framework interno. Irei falar disso no texto.

Segue sugestão e vídeo:

https://youtu.be/ODXq2KwTGyA