asp.net web api帮助文档的说明

为asp.net的mvc web api填写自己的帮助文档

1. 添加Help的area(可以通过命令行或其他方式添加)

命令行:Install-Package Microsoft.AspNet.WebApi.HelpPage

NuGet搜索:HelpPage,找到Microsoft asp.net web api help page

2. 为api等添加注释

3. 生成注释为xml文件

4. 将xml赋予Help的configuration

    在help的config文件中 HelpPageConfig.Register(HttpConfiguration config):

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/sfa.web.XML")));


 

5. debug查看

 

6. 可选:在帮助页面添加测试工具

参考:http://blogs.msdn.com/b/yaohuang1/archive/2012/12/02/adding-a-simple-test-client-to-asp-net-web-api-help-page.aspx



©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页