Monday, 12 May 2014

Web API Documentation


ApiExplorer:
  • Install it from: http://go.microsoft.com/fwlink/?LinkId=282650
  • Enable Xml documentation from the Build tab in the Project Properties section so that the Xml files are writen into an Xml file.
  • Add some comments to the Controller or Properties
  • When you build the app then the Xml file

You can either read the xml comments from an xml file or via the code XML documentation comments.

Default:

~/App_Data/XmlDocument.xml


  • http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages
  • http://blogs.msdn.com/b/yaohuang1/archive/2012/09/30/asp-net-web-api-help-page-part-1-basic-help-page-customizations.aspx
  • http://blogs.msdn.com/b/yaohuang1/archive/2012/12/10/asp-net-web-api-help-page-part-3-advanced-help-page-customizations.aspx
  • 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



No comments: