Extensions for Microsoft ASP.NET Web API Help Pages
- Show controllers and methods using
Authorize
attribute on documentation page - Properly support tags like
<c>
,<code>
,<para>
,<example>
,<exception>
,<paramref>
,<see>
,<seealso>
,<typeparamref>
- Install the NuGet package, and overwrite all files when asked.
- Open Properties for your web api project, and select the
Build
tab. UnderOutput
, checkXML documentation file
. In the edit box, typeApp_Data/XmlDocument.xml
. - Open the
Areas\HelpPage\HelpPageConfig.cs
file and change the following line: //config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("/App_Data/XmlDocument.xml"))); to config.SetDocumentationProvider(new MultipleXmlDocumentationProvider(HttpContext.Current.Server.MapPath("/App_Data/XmlDocument.xml"))); - Document your controller and models using standard .NET documentation comments
- For more advanced stuff, follow the guide at http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages