Инструменты документации Asp.Net Web API для поддержки редактирования описания
Я ищу инструмент документации или генератор для приложения веб-API asp.net. Инструмент должен позволять редактировать описание / сводку методов или параметров API. Мне может понадобиться это, чтобы позволить различным командам, например, PM, QA, также редактировать документацию, так что не всегда это должны быть разработчики.
Пожалуйста, предложите любые хорошие инструменты, которые поддерживают это требование.
2 ответа
Мы использовали Swagger для документирования наших API. Этот пакет Nuget Swashbuckle добавляет Swagger в ваш проект API. https://github.com/domaindrivendev/Swashbuckle
Документация создается с комментариями XML и отображается в приятном интерфейсе пользовательского интерфейса, с помощью которого вы можете даже протестировать свои API.
Спасибо за ответ. Я с тобой согласен.
Теперь я ищу инструмент для онлайн-документации, которая генерируется из моего существующего XML-документа. Эта онлайн-документация может быть в дальнейшем отредактирована членами команды и опубликована.