Enable API description information in Webapi 2 (description under Help)

Source: Internet
Author: User

Environment: Vs2013+web API 2

Issue: The new Web API 2 project, which is created by default, displays information about the API under the Help page, but the description column does not have access to the data, as shown in:

Solve:

1. Enable the output XML document file first:

On the Web API project, right-click Properties, under the "Generate" tab of the property page, tick the output below "XML document file" as shown in:

2. In the solution manager, hit HelpPageConfig.cs, remove the Setdocumentationprovider method, and change the address to correspond to 1, as shown in:

3. Add a comment to the API as shown in:

Run the project again, open the API help page and you'll see the effect as shown in:

Reference: ASP. NET Web API help Page documentation using XML comments on controllers

Enable API description information in Webapi 2 (description under Help)

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.