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 API项目
- ASP.NET中Web API的简单实例
- ASP.NET MVC Web API HttpClient简介
- ASP.NET Web Api 2实现多文件打包并下载文件的实例
- 支持Ajax跨域访问ASP.NET Web Api 2(Cors)的示例教程
- ASP.NET Web API教程 创建Admin视图详细介绍
- ASP.NET Web API教程 创建Admin控制器实例分享
- ASP.NET Web API教程 创建域模型的方法详细介绍
- .Net Web Api中利用FluentValidate进行参数验证的方法
本文由 华域联盟 原创撰写：华域联盟 » ASP.NET Web API如何将注释自动生成帮助文档
转载请保留出处和原文链接：https://www.cnhackhy.com/57295.htm
