ASP.NET l'API Web - générer Automatiquement la documentation de l'API

Question

Nous sommes la construction d'une API RESTful projet à l'aide de ASP.NET l'API Web.

Nous sommes à la recherche d'un moyen facile de générer automatiquement les documents pour chaque appel de méthode que nous exposons dans notre API, y compris - les verbes HTTP, URI, paramètres et la méthode de l'échantillonnage des charges utiles.

Quelqu'un peut-il recommander des outils et des approches qu'ils ont utilisé pour cela un ASP.NET projet d'API Web?

Sont là, même les outils qui va le faire? Ou est-ce que ça va être une discipline processus manuel?

Answer 1

La webapi équipe est actuellement en train de travailler sur un outil pour générer la documentation. L'outil est appelé 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

Mise à jour: Voici la documentation officielle: http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

Answer 2

D'accord avec Daniel. En attendant, vous pourriez vouloir vérifier Swagger. Je n'ai pas utilisé personnellement, mais il a l'air soigné et j'ai entendu de bonnes choses à ce sujet.