ASP.NET Web API 创建帮助页



1. 安装 Microsoft.AspNet.WebApi.HelpPage 程序包

Install-Package Microsoft.AspNet.WebApi.HelpPage

2. 注册 Area

protected void Application_Start() { AreaRegistration.RegisterAllAreas(); }

3. HelpPageConfig 启用 SetDocumentationProvider

WebApplication/Areas/HelpPage/App_Start/HelpPageConfig.cs 目录下，找到下面代码，并取消注释（App_Data 改为 bin）：

public static void Register(HttpConfiguration config) { //// Uncomment the following to use the documentation from XML documentation file. config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/XmlDocument.xml"))); }

4. WebApplication Build 配置 XmlDocument 输出路径

5. ValuesController 代码

/// 
 /// Values控制器 ///  public class ValuesController : ApiController { ........ /// 
 /// POST 操作 ///  /// value值 public void Post([FromBody]string value) { } }

6. 效果

Help Page

Help/Api/POST-api-Values

作者：田园里的蟋蟀