Enable the Api Description in WebApi 2 (Description in Help) and webapide.pdf

Enable the Api Description in WebApi 2 (Description in Help) and webapide.pdf

Environment: vs2013 + web api 2

Problem: by default, the Web Api 2 project is created. The Api information is displayed on the Help page, but the Description Column cannot obtain data, as shown in:

Solution:

1. Enable the output XML document file:

Right-click a web api project and choose Properties. Under the "generate" tab on the property page, select the following "XML document file", as shown in:

2. In solution manager, type HelpPageConfig. cs, remove the SetDocumentationProvider method, and change the address to the corresponding one in 1, as shown in:

3. Add comments to the Api, as shown in:

Run the project again and open the Api Help page to see the effect, as shown in:

 

Reference: ASP. NET Web API Help Page documentation using Xml comments on controllers