ASP.NET Web API从注释生成帮助文档
2015-07-10 17:58
465 查看
默认情况下,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 页面,就能看到效果了。
首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document file,输入将要生成的XML文件放置的路径,比如:App_Data\OpenAPI.XML。
然后编译项目,就会在对应的路径下生成xml文件。
接着打开 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件,取消 config.SetDocumentationProvider 代码的注释,修改一下路径:
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));
然后重新编译,访问 /help 页面,就能看到效果了。
相关文章推荐
- ASP.Net MVC学习(二)
- ASP.NET MVC下的四种验证编程方式[续篇]【转】
- ASP.NET MVC下的四种验证编程方式【转】
- asp.net 显示等待提示,完成后隐藏消失
- Windows Server 2012/win8 iis8 上安装 asp.net 4.5 当时用了mvc5 .net framework 4.5 所以得装下
- ASP.NET MVC Model验证总结【转】
- 给asp.net刚学的人的一点经验(一)
- 给asp.net刚学的人的一点经验(一)
- WCF技术剖析之六:为什么在基于ASP.NET应用寄宿(Hosting)下配置的BaseAddress无效
- WCF技术剖析之五:利用ASP.NET兼容模式创建支持会话(Session)的WCF服务
- asp.net 去重复验证
- 【Metasploit魔鬼训练营--实践笔记】4.2.3 SQL 注入漏洞探测
- ASP.NET性能优化之减少请求
- asp.net 接入微信公众平台,回复消息,解决乱码问题
- WCF技术剖析之二:再谈IIS与ASP.NET管道
- WCF技术剖析之一:通过一个ASP.NET程序模拟WCF基础架构
- ASP.NET控件组(lable1、label2、label3.....labeln)的赋值
- asp.net实现三层架构的例子
- 介绍“Razor”— ASP.NET的一个新视图引擎
- [每日刷题(2015/7/10)]简述ASP.NET的页面运行机制