WebApi2 Help帮助文档显示当前Action方法名称以及注释信息

环境：vs2017+Web Api2

首先，显示Web Api  Help 里的Action方法：

之前只显示控制器名称和请求类型：

 

 

想要显示控制器下面的Action方法名字只需要更改路由就可以，步骤：打开App_Start文件夹下的WebApiConfig.cs，在routeTemplate属性里加一个Action：routeTemplate: "api/{controller}/{Action}/{id}",

 

 

 

 更改完成后就可以显示控制器里面的方法了。

 

 至于后面的Description就是当前方法的注释，步骤：

1、选择当前项目右击选择属性-->生成，把XML文档文件选项框勾选上；

 

 2、打开Areas-->HelpPage-->App_Start-->HelpPageConfig.cs,添加SetDocumentationProvider方法，其中的路径更改为上图中XML文档的路径；

 

然后在方法上添加注释就可以了，注意注释格式，格式不对读取不出来

 

 效果：

 

 这样Web Api Help 里的Action和注释就都显示出来了，其中Action显示用起来很方便，后边的那个注释就没太大必要了，因为在当前项目中无论哪个类和方法一旦没有写注释或者注释的格式不对，就会出现绿色的波浪线，虽然不会报错，但是看起来很不舒服。如图：

 

 当然，对项目没什么影响，一切取舍还是看个人吧。