如何使用WisdomTool REST Client定制满足您个性化需求的API文档?

WisdomTool REST Client 支持自动化测试RESTful API,输出精美的测试报告,生成精美的RESTful API文档。

这里介绍一下如何定制个性化的RESTful API文档。

定制个性化API文档前请先使用工具测试REST API,产生历史记录;

再去选择菜单选项 Apidoc --> Create生成API文档;

最后,修改数据文件work/apidoc/js/apidata.js

根据您的实际需求可以修改如下属性:

修改默认的文档描述(详见属性api_description);

修改默认的请求/响应参数(详见属性model);

修改API简介(详见api_summary)等数据。

注意: 这些修改必须符合JSON语法。

原文地址:https://www.cnblogs.com/witpool/p/8110881.html

时间: 2024-10-11 03:55:07

如何使用WisdomTool REST Client定制满足您个性化需求的API文档?的相关文章

使用WisdomTool RESTClient如何在Linux和Mac上获取测试报告和API文档?

使用WisdomTool RESTClient自动化测试REST API,生成REST API文档, 需要先执行命令java -jar restclient-1.1.jar启动WisdomTool RESTClient界面. 先使用工具测试REST API,产生历史记录. 选择菜单选项 Apidoc --> Create 生成API文档: work/apidoc/apidoc.html 选择菜单选项 Test --> Start Test 生成测试报告: work/report/report.

Web API 自动生成帮助文档并使用Web API Test Client 测试

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下. 先看一下生成的webapi文档. 1.下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述. 2.点击红框内的链接,打开api方法的详情页面,如下图所示, 3.点击Test API打开如下页面 4.输入参数,点击S

【VMware虚拟化解决方案】VMware Horizon View Client 各平台配置文档

云桌面用户手册 XXXX部 2014年05月18日 文档版本 文档名称 XXXX公司云桌面用户手册 保密级别 商密 文档版本编号 1.0 制作人 制作日期 2014-04-24 复审人 复审日期 扩散范围 公司内部使用人员 变更记录 版本编号 版本日期 修改者 说明 文档说明 此文档为XXXX公司内部员工关于<云桌面用户手册>培训文档. 此文档只对公司内部员工传阅,并只针对公司内部员工问题给予解决. 目录 1.VMware Horizon View Client下载地址... 4 2.桌面连接

书剑恩仇录online全套源代码(服务端+client+文档)

书剑恩仇录online全套源代码(服务端+client+文档).vc++开发,解压后将近10G大小,眼下网上最完整版本号,包括client源代码.服务端源代码.工具源代码.sdk.文档-- <书剑恩仇录>是依据同名小说改编的3D大型网游,由国内麒麟游戏200名精英研发人员倾情打造. 麒麟游戏在<书剑恩仇录>改编网游的过程中.以原著小说情节为线索展开游戏剧情,利用率先的自主研发引擎技术,在江南武林帮会红花会与清廷斗争的时空背景下,细腻刻画了原著中陈家洛与香香公主的爱恨情仇,以及快意江

Grid Infrastructure Single Client Access Name (SCAN) Explained (文档 ID 887522.1)

APPLIES TO: Oracle Database - Enterprise Edition - Version 11.2.0.1 and laterExalogic Elastic Cloud X4-2 Half RackInformation in this document applies to any platform. PURPOSE 11gR2 Grid Infrastructure (CRS) introduced Single Client Access Name (SCAN

MFC MDI程序 定制 文档模板 运行时全部打开 禁用关闭按钮

==================================声明================================== 本文原创,转载在正文中显要的注明作者和出处,并保证文章的完整性. 未经作者同意请勿修改(包括本声明),保留法律追究的权利. 未经作者同意请勿用于出版.印刷或学术引用. 本文不定期修正完善,为保证内容正确,建议移步原文处阅读. 本文链接:http://www.cnblogs.com/wlsandwho/p/4282242.html =============

Docker集群实验环境布署--swarm【6 配置上层Nginx代理,让任意Docker client访问得到高可用的管理API】

10.40.42.10上,也就是对应的VRRP中的10.40.42.1和2上,配置nginx tcp代理 # cat 4000_manager.venic.com_10.40.100.141-142_4000.conf upstream manager.venic.com { server 10.40.100.141:4000; server 10.40.100.142:4000; } server { listen 4000; proxy_pass manager.venic.com; } 重

Android含文档server结束(client UI接口异步请求的一部分)三

在本文中,AsyncTask为了实现异步请求,详细代码如下所示的: public class downloadActivity extends Activity { private TextView myTextView=null; private Button button=null; private static final String path="http://192.168.0.179:8080/Myweb/download.do"; private ProgressDial

ECharts图表系统 特性总览

最近在玩ECharts,感觉真心不错,在这里把官方的资料收集收集,给大家推荐一下下~ Architecture ECharts (Enterprise Charts 商业产品图表库) 提供商业产品常用图表,底层基于ZRender(一个全新的轻量级canvas类库),创建了坐标系,图例,提示,工具箱等基础组件,并在此上构建出折线图.柱状图.散点图.K线图.饼图.雷达图.地图.和弦图.力导向布局图.仪表盘以及漏斗图,同时支持任意维度的堆积和多图表混合展现. 支持IE6/7/8/9+,chrome.f