Documentando APIs em Asp.Net MVC com Swagger

Criação do projeto

Criando novo projeto
Selecionando um tipo de projeto
Definindo a arquitetura
Estrutura final

Instalação do Swagger

Abrindo o nuget manager console
Swagger sendo referenciado no projeto
Swagger em funcionamento

Configuração do Swagger

Propriedades do projeto
Configuração para gerar o XML documents
Código de configuração do Swagger

Demais configurações

Documentando métodos

Resultado da tag <summary>
Resultado da tag <remarks>
Resultado da tag <remarks> para exemplificar modelo
Resultado da tag <param>
Resultado da tag <response> e da anotação [SwaggerResponse]
Resultado da tag <summary> nas propriedades
Resultado da anotação [Required]

Conclusão

Referências

Bachelor in Computer Science, MBA in Software Architecture and .NET Developer.

Love podcasts or audiobooks? Learn on the go with our new app.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Alex Alves

Alex Alves

Bachelor in Computer Science, MBA in Software Architecture and .NET Developer.

More from Medium

SQLite Working Directory Error with EF Core Web Api

Real-time Code Quality with SonarLint in Visual Studio

View Components in ASP.NET Core

Swagger returns 500 Internal server error