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

本文介绍如何在WebAPI项目中设置HelpPage文档,包括创建项目、修改HelpPageConfig.cs文件、配置项目属性等步骤,并介绍了如何使用测试工具检查文档是否正确生成。

http://www.2cto.com/kf/201607/522971.html

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

\

 

==========下面开始干活==========

一、创建 WebApi 项目

  \

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

  \

  \

 

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

 

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

  \

 

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

  \

  \

 

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

 

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

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

  \

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

  \

 

转载于:https://www.cnblogs.com/lijiasnong/p/6269770.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值