Документирование API веб-сервиса с помощью OpenAPI спецификации

Аннотация

Необходимость документации тех или иных аспектов своего продукта всегда присутствовала для разработчиков информационных систем. С развитием всемирной информационной паутины, роста популярности REST и интеграции различных сервисов между собой важность документации только повысилась. Отдельной темой стало документирования API своего продукта. Хорошо задокументированный API облегчает его использования, упрощает интеграцию с текущим продуктом, упрощает тестирование и дальнейшую разработку внутри команды. В данной статье будет продемонстрировано решение с использованием OpenAPI спецификации, также известной, как Swagger спецификация. В качестве примера будет использован .NET Framework и язык программирования C#.