Documentando APIs .Net Core com o Swagger

novembro de 2021

Autor: Rodolfo dos Santos Pinto

Nesse artigo vou demostrar como é simples e fácil implementar o Swagger para documentar suas APIs Rest. 

Para mais informações acesse: 

https://docs.microsoft.com/pt-br/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-2.2

A API que vamos utilizar como base foi desenvolvida em Artigos anteriores, confira no Link a seguir: 

https://medium.com/trainingcenter/web-api-com-net-core-2-2-e-mongodb-e44fa72b5f84

Agora que já temos a nossa API, vamos instalar o pacote Nuget Swashbuckle.AspNetCore 

Com o pacote já instalado, vamos até a classe Startup e adicionar o seguinte código no método ConfigureServices, nessa etapa é criado um arquivo .Json, que será consultado para liberar o swagger.ui (a interface visual do Swagger). 

E no método Configure vamos habilitar o swagger UI, lendo o Swagger.json criado anteriormente. 

Por fim, sobre cada método do Controllers, vamos especificar qual sua função para complementarmos a nossa documentação. Utilizando a TAG <sumary> 

Testes 

As implementações são apenas essas, vamos realizar o teste ao executar a aplicação. Acesse o “Aplicação”/swagger/index.html 

Swagger UI 

Note que todos os métodos da nossa API Hero estão disponíveis e é possivel executa-los pela própria interface. 

Vamos fazer um Post através no Swagger.UI 

Post Executado com sucesso! Em alguns passos já temos nossa API documentada com o Swagger 


Compartilhe nas redes sociais Compartilhe nas redes.