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")))

通过以上的简单介绍，希望对大家有所帮助