Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

azzlack/Microsoft.AspNet.WebApi.HelpPage.Ex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Microsoft.AspNet.WebApi.HelpPage.Ex

Extensions for Microsoft ASP.NET Web API Help Pages

Features

  • Show controllers and methods using Authorize attribute on documentation page
  • Properly support tags like <c>, <code>, <para>, <example>, <exception>, <paramref>, <see>, <seealso>, <typeparamref>

Usage

  1. Install the NuGet package, and overwrite all files when asked.
  2. Open Properties for your web api project, and select the Build tab. Under Output, check XML documentation file. In the edit box, type App_Data/XmlDocument.xml.
  3. 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")));
  4. Document your controller and models using standard .NET documentation comments
  5. For more advanced stuff, follow the guide at http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

About

Extensions for Microsoft ASP.NET Web API Help Pages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published