dudu通过本文主要向大家介绍了精通asp.net web api,web程序设计asp.net,vs2010 asp.net web,简述asp.net的web窗体,asp.net等相关知识,希望对您有所帮助,也希望大家支持linkedu.com www.linkedu.com
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")))
</div>
通过以上的简单介绍,希望对大家有所帮助
</div>您可能想查找下面的文章:
- ASP.NET core Web中使用appsettings.json配置文件的方法
- 详解ASP.NET WEB API 之属性路由
- ASP.NET webUploader上传大视频文件相关web.config配置
- asp.net web页面自定义分页控件使用详解
- ASP.NET Web.config配置文件详解
- ASP.NET web.config 配置节点详解
- ASP.NET Web Api 2实现多文件打包并下载文件的实例
- ASP.NET web.config中 数据库连接字符串加密解密
- 在ASP.NET 2.0中操作数据之五十三:在Data Web控件显示二进制数据
- asp.net基于Web Service实现远程上传图片的方法