Loopback自动添加ShowDoc文档及API测试

Showdoc API loopback （项目地址：https://coding.net/u/zealseeker/p/showdoc-api-loopback/git ）是一款用于 Loopback （基于Express的RESTful 框架）中的 API 测试以及基于 ShowDoc 文档自动上传的工具。通过写测试脚本，用户可以方便的进行有上下文的接口测试，并且同时将需要写成文档的接口上传至ShowDoc自动进行文档维护。主要依赖于Nodejs中的Request包以及ShowDoc的文档接口。

在Loopback中主要有两个地方需要写接口文档，一个是数据字典，也即是每个模型的定义，本工具可以自动通过模型的json文件以及简单的配置规则将此转化成文档的形式上传。另一个是方法接口，本工具可以在写测试脚本的同时定义“Doc”，这样既能够进行接口的单元测试，同时也可以将该测试内容作为接口例子上传到文档里，该功能同样也适用于其他后台接口的调试与文档制作。

目前还无法直接嵌入到loopback或其他程序中，只能单独作为测试脚本运行，并且config.json中要手动填写接口的根地址。

安装与使用：

git clone https://git.coding.net/zealseeker/showdoc-api-loopback.git
cd showdoc-api-loopback
npm install
# 修改 config.json 文件
node .

配置方法

在config.json中配置 ShowDoc 中的api_key和api_token，如果是自己配置的文档服务器，则设置doc_host，具体参照 https://www.showdoc.cc/page/102098 。
model 属性是需要添加的文档模型，对应根目录的 json 文件，默认有data.json和api.json。

测试脚本调用方法及案例详情请看Coding项目。