为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
时间: 2024-10-29 19:05:54