Usar o Swashbuckle para criar um documento OpenAPI
Antes de uma API Web ser publicada no Gerenciamento de API do Azure com o Visual Studio, ela precisa ter um documento de descrição OpenAPI.
O documento OpenAPI é usado pelo Gerenciamento de API para localizar os pontos de extremidade da API Web. Fica mais fácil para os desenvolvedores da VanArsdel criarem uma descrição OpenAPI para as APIs Web com as ferramentas do Swashbuckle.
O que é o OpenAPI e o que ele faz?
O documento OpenAPI define uma descrição de interface padrão que é independente de linguagem de programação para APIs Web. Com esse documento, tanto os humanos quanto os computadores podem localizar e entender os recursos de um serviço sem ter acesso ao código-fonte, à documentação extra nem à inspeção do tráfego de rede.
O documento OpenAPI é um contrato para APIs Web. É tudo que um aplicativo de consumo precisa para entender as APIs Web e se comunicar com elas, sem precisar saber onde elas estão localizadas nem se estão em execução.
Gerar um documento OpenAPI por meio de um aplicativo de API Web do ASP.NET Core
Há várias maneiras de gerar um documento OpenAPI por meio de um aplicativo de API Web do ASP.NET Core. O Swashbuckle é a maneira mais popular de fazer isso.
É fácil de usar e, uma vez instalado no seu aplicativo, exibe automaticamente a tela do Swagger UI.
O Swashbuckle também gera dinamicamente o documento OpenAPI, que inclui todos os detalhes dos endpoints da API, estruturas de payload, requisitos de segurança, etc. Aqui está o documento de exemplo para a API web de gerenciamento de inventário da VanArsdel.
Na próxima unidade, um exercício mostrará como habilitar esse recurso OpenAPI para seu aplicativo ASP.NET Core Web API.