首先,创建一个WebApi项目,vs会自动根据模版创建一个完整的webapi程序,其中包括了自动文档的一切。
但是,这个功能却是关闭的。。。。蛋疼。。。。偏偏还没有地方显式的告诉打开的方法和步骤。。。。无语。。。
好了,现在先说如何打开webapi接口的自动文档:
一:项目右键属性,选择"生成"栏目,指定接口文档xml文件的路径和名字
二:打开帮助文档子项目的配置文件,解开红框标注的配置项,并把文件路径设置成跟上面项目生成配置的一样
三:在指定路径下,新建这个xml文件,这点不要忘了,一定要是标准的xmL文件,带规范的文件头和root节点的!!
好了,接口的自动说明文档已经打开了,重新编译并运行,看看效果:
是不是很帅
接下来,我们再说说如何添加测试功能。
说起来,帮助文档都做到这一步了,再加个测试功能,对微软来说,很难吗?很难吗?蛋疼啊。。。。非要我们自己弄。。。。无语啊。。。。
废话不多说了,言归正传
一:项目右键打开nuget管理器,找到WebApiTestClient包,安装之
二:打开帮助文档子项目视图文件Api.cshtml,添加右边红框标注内容
ok,测试功能加好了
现在再次编译运行,看看效果
怎么样,简不简单?爽不爽?
有同学要问了,别人都在用swagger,为毛你不用?
好吧,怎么说呢,你有没有发现WebApiTestClient包特别小?
对了,他是一个前端小插件,也就是上图的那个按钮加弹出的测试框!!!
嗯,仅仅只是一个小小的前端插件,所以我就用他了!!!就是这么简单!!!
如果还不理解,就再想想吧!!