Asp.net MVC WebApi 的接口文档生成、测试功能
注意点:
1.mvc的控制器必须继承于ApiController,否则看不到的
2. 简单查看xml,根据第二步即可生成xml,可视感比较低,但是内容全部有,不限定于Api
一、设置
二、打开帮助文档子项目的配置文件,解开红框标注的配置项,并把文件路径设置成跟上面项目生成配置的一样
三、在指定路径下,新建这个xml文件XmlDocument.xml,这点不要忘了。或编译先生成XmlDocument.xml,然后加入这个文件
四、接口的自动说明文档已经打开了,重新编译并运行,看看效果
添加测试功能
1、用nuget管理器,安装WebApiTestClient包
安装成功后,项目会自动添加一些主要文件:
Scripts\WebApiTestClient.js
Areas\HelpPage\TestClient.css
Areas\HelpPage\Views\Help\DisplayTemplates\TestClientDialogs.cshtml
Areas\HelpPage\Views\Help\DisplayTemplates\TestClientReferences.cshtml
2、使用测试组件
修改Areas/HelpPage/Views/Help/Api.cshtml,添加以下内容:
@Html.DisplayForModel("TestClientDialogs") @section Scripts{ <link href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" /> @Html.DisplayForModel("TestClientReferences") }
添加位置:
3、运行
点击测试 POST PTL/IO
点击右下角 Test API