ASP.NET Web API如何将注释自动生成帮助文档
2015-07-20 00:00
801 查看
ASP.NET Web API从注释生成帮助文档
默认情况下,ASP.NET Web API不从Controller的注释中生成帮助文档。如果要将注释作为Web API帮助文档的一部分,比如在帮助文档的Description栏目中显示方法注释中的summary,需要进行一些配置操作。
首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document file,输入将要生成的XML文件放置的路径,比如:App_Data\OpenAPI.XML。
然后编译项目,就会在对应的路径下生成xml文件。
接着打开 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件,取消 config.SetDocumentationProvider 代码的注释,修改一下路径:
然后重新编译,访问 /help 页面,就能看到效果了。
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))
通过以上的简单介绍,希望对大家有所帮助
相关文章推荐
- asp.net中用soapheader作验证的使用步骤: 很简单
- asp.net 2.0中傻瓜式使用soap header
- asp.net 缓存
- VS2010部署Asp.net程序到本地IIS 7
- (转)ASP.NET前台代码绑定后台变量方法总结
- onClick和onclientclick区别
- Spring基于注解@AspectJ的AOP
- 架构设计(ASP.NET MVC+Knockout+Web API+SignalR)
- ASP.NET MVC 之控制器与视图之间的数据传递
- Asp.Net中WebServices的调用方式
- ASP.net后台弹出消息对话框的方法!【转】
- spring AspectJ的Execution表达式-备忘笔记(转)
- ASP.NET - 缓存(Cache)
- ASP.NET2.0下实现分布式StateServer(状态服务器)
- Asp.Net 4.5网站使用IIS发布 uploadify插件 上传文件大小问题
- asp.net站点报错“对象的当前状态使该操作无效。”的解决办法
- 用 snprintf / asprintf 取代不安全的 sprintf
- C#、ASP.NET、WinForm - 实现邮件发送的功能
- ASP.NET中将声音文件添加到资源中并进行播放的方法
- ASP.NET的Page_Load事件