.NET：WebApi 生成帮助文档及顺便创建简单的测试工具

Posted 2020-08-05 反骨仔

　　==========最终的效果图==========

 

 ==========下面开始干活：生成帮助文档==========

一、创建 WebApi 项目

　　

二、找到 HelpPageConfig.cs 并取消代码注释

　　

　　

 

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

 

三、对项目单击右键，选择属性，按图操作

 　　

 

四、启动项目，输入Url： localhost:{端口号}/help

　　

　　点击上图就跳会跳转到下图。

　　

 

 　　【注】Description 没有显示内容是因为我们没有在对应的方法上面以 /// 的形式进行注释

 

==========下面是顺便自动创建简单测试工具的分割线==========

一、对项目单击右键，选择“管理 NuGet 程序包”，搜索一下“apitest”

　　

二、装完之后再启动进去查看方法，就会发现右下角有个按钮“Test api”