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

Posted 2020-10-18 代码之美

定制个性化API文档前请先使用工具测试REST API，产生历史记录，再去选择菜单选项 Apidoc --> Create生成API文档。 之后，修改数据文件work/apidoc/js/apidata.js，根据您的实际需求去 修改默认的文档描述（详见属性api_description）； 修改默认的请求/响应参数（详见属性model）； 修改API简介(详见api_summary)等数据。 注意: 这些修改必须符合JSON语法。

Wisdom RESTClient 支持自动化测试RESTful API，输出精美的测试报告，生成精美的RESTful API文档。

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

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

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

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

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

修改默认的文档描述（详见属性api_description）；

修改默认的请求/响应参数（详见属性model）；

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

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