ASP.NET Web API - Автоматическая генерация документации API

Мы создаем проект API RESTful с использованием веб-API ASP.NET.

Мы ищем простой способ создания документации автоматически для каждого вызова метода, который мы раскрываем в нашем API, включая: HTTP-глаголы, URI, ожидаемые параметры и полезную нагрузку для образца.

Может ли кто-нибудь рекомендовать некоторые инструменты и подходы, которые они использовали для достижения этого для проекта ASP.NET Web API?

Есть ли даже инструменты, которые сделают это? Или это будет дисциплинированный ручной процесс?

Ответ 1

В настоящее время команда webapi работает над инструментом для создания документации. Инструмент называется ApiExplorer.

http://blogs.msdn.com/b/yaohuang1/archive/2012/05/13/asp-net-web-api-introducing-iapiexplorer-apiexplorer.aspx

http://blogs.msdn.com/b/yaohuang1/archive/2012/05/21/asp-net-web-api-generating-a-web-api-help-page-using-apiexplorer.aspx

Обновление: вот официальная документация: http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

Обновление 3/1/2015 - существует проект под названием Swashbuckle, который использует ApiExplorer для создания Swagger Документов. (Github, Nuget)

Ответ 2

Только что выпустила библиотеку OSS под названием Swank, которая делает это. Автоматически создает документацию, поддерживает комментарии XML, уценку, emojis, coventions и т.д.: http://www.mikeobrien.net/swank/