前段时间有个项目用到了webapi,不得不说,webapi的自动生成的接口帮助文档实在是太方便了。不过好用归好用,默认生成的文档还是有些小小的问题的,还需要稍微改良一下。
使用webapi生成的接口文档默认是这样子的,虽然我在接口和参数中都加了注释,然而并没有显示:
为了将注释显示出来,需要如下几个步骤:
1.必须先生成接口和Model参数的xml文档。方法如下:
分别选中Model项目和API项目【属性-生成-输出-XML文档文件】(其中Model项目XML为接口参数说明,API项目XML为接口方法说明),如下图所示:
2.生成好xml文档后,要配置到接口的帮助文档中,方法如下:
打开Areas/HelpPage/App_Start/HelpPageConfig.cs,注意看,原始文件中有如下一句代码: