ASP.NET Web API 2个步骤启用 Help 说明

使用 VS 来创建 WEB API 有个好处,它自动将 Help Page 帮你创建好了。这个 Help Page 的功能可大了去了,如果你一开始跟我一样对 Routing 这个功能不了解,你可以通过 Help 来看你的 Route 到底出了什么什么问题。

Anyway,如果自动创建好了 Help,那么还有什么好说的?

因为,虽然创建了 Help,但是它没自动将说明的功能启动起来。

截图1

天底下没有新鲜的事,这个问题网上早就有答案了 。 所以,谢谢互联网和 IT@找着了

简单说一下我怎么做的,如果使用了 Web API2 创建项目,那么应该自动就有了 Area 这个文件夹,里面包括了 HelpPage。

那么,只要2个步骤就可以了:

第一步
到 HelpPage/App_Start 里打开 HelpPageConfig.cs 这个文件,找到被注释了的这段代码,去掉注释

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

第二步
进入项目属性,然后到 Build 这个界面里将 Output 下的 XML Documentation File 路径指到上面的 MapPath 值(App_Data/XmlDocument.xml)就可以了。
截图2

就可以了。如果没有启用,所有的 Description 就会跟第一行一样 - No documentation available 。截图3

©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页