ASP.NET Web API如何将注释自动生成帮助文档

更新时间：2015年07月20日 17:27:03 作者：dudu

本篇文章主要介绍了ASP.NET Web API从注释自动生成帮助文档的方法，功能很是强大，现与大家分享一下,需要的朋友可以参考下

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 Web Page应用深入探讨
这些内容是我在学习ASP.Net的时候对Page研究的一些心得，具体的细节没有很详细的探讨，更多的内容请大家参考MSDN，但是我举了一些初学者常犯的错误和出现错误的原因，希望可以给大家带来启发。
2009-08-08
php基础练习--简单验证码实现
这篇文章主要介绍了php基础练习--简单验证码实现,需要的朋友可以参考下
2014-02-02
Asp.net基于ajax和jquery-ui实现进度条
这篇文章主要介绍了Asp.net基于ajax和jquery-ui实现进度条,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-12-12
Asp.net MVC中使用JQuery插件ajaxFileUpload上传文件
这篇文章主要介绍了Asp.net MVC中使用JQuery插件ajaxFileUpload上传文件,需要的朋友可以参考下
2016-08-08
Equals和==的区别公共变量和属性的区别小结
Equals 和==的区别公共变量和属性的区别总结一下。
2009-11-11
浅谈asp.net Forms身份验证详解
这篇文章主要介绍了浅谈asp.net Forms身份验证详解，这种方法可以轻松的保持用户的登录状态（如果用户想这样），便捷的用户授权配置，增强的安全性，有兴趣的可以了解一下。
2016-12-12
在.NET 6.0中自定义接口路由的方法
这篇文章主要介绍了在.NET 6.0中自定义接口路由,在本文，我们学习了如何使用终止中间件组件作为接口，并用将该接口映射到新的路由引擎，从而让我们的路由变得更加强大和灵活，需要的朋友可以参考下
2023-04-04
详解.NET中的加密算法总结(自定义加密Helper类续)
这篇文章主要介绍了详解.NET中的加密算法总结(自定义加密Helper类续) ，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
2016-12-12
WPF简介与基础开发
WPF是微软推出的基于Windows的用户界面框架，这篇文章介绍了WPF的基础开发，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-02-02
javascript判断是否有对RadioButtonList选项选择
写个Javascript来判断是否有对RadioButtonList选项选择,附动画演示，感兴趣的朋友可以了解下，希望对您们有帮助
2013-01-01