手机版

ASP.NET网络应用编程接口如何从注释中自动生成帮助文档

时间:2021-09-09 来源:互联网 编辑:宝哥软件园 浏览:

ASP.NET网络应用编程接口从注释中生成帮助文档

默认情况下,ASP.NET网络应用编程接口不会根据控制器的注释生成帮助文档。如果注释要用作网络应用编程接口帮助文档的一部分,例如在帮助文档的描述列中的方法注释中显示摘要,则需要一些配置操作。

首先在Visual Studio中打开Web API项目的属性页,在Build设置页面中选择XML文档文件,输入将要生成的XML文件的放置路径,如App_Data\OpenAPI。可扩展置标语言.

然后编译这个项目,在相应的路径下会生成一个xml文件。

然后打开areas \ help page \ app _ start \ help page config . cs文件,取消对config.setdocumentprovider代码的注释,并修改路径:

然后重新编译并访问/help页面查看效果。

复制代码如下: config . setdocumentprovider(new xmldocumentprovider(httpcontext . current . server . mappath(~/app _ data/open API . XML '))

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

版权声明:ASP.NET网络应用编程接口如何从注释中自动生成帮助文档是由宝哥软件园云端程序自动收集整理而来。如果本文侵犯了你的权益,请联系本站底部QQ或者邮箱删除。