DOClever使用帮助手册

目 录快速开始序言快速创建项目快速创建接口详细使用基础注册登录创建工程项目分类接口管理创建接口接口编辑接口分组注入接口调试接口测试一键生成数据效验内网调试Mock数据项目设置状态码全局环境注入文档BaseUrl项目成员公开化导出自动化测试简单测试高级测试组合测试后台轮询版本管理项目版本接口快照团队协作创建团队分配项目- 2 -本文档使用 看云 构建管理组员团队项目总后台管理线下部署windowslinux(mac)常见问题更新日志- 3 -本文档使用 看云 构建快速开始DOClever-移动时代首选接口管理平台！DOClever是一个可视化接免费开源的口管理工具 ,可以分析接口结构，校验接口正确性， 围绕接口定义文档，通过一系列自动化工具提升我们的协作效率。DOClever前后端全部采用了javascript来作为我们的开发语言，前端用的是vue+element UI，后端是express+mongodb，这样的框架集成了高并发，迭代快的特点，保证系统的稳定可靠。主要特性：• 可以对接口信息进行编辑管理，支持 get,post,put,delete,patch 五种方法，支持 https 和 https 协议，并且支持 query，body，json，raw，rest，formdata 的参数可视化编辑。同时对 json 可以进行无限层次可视化编辑。并且，状态码，代码注入，markdown 文档等附加功能应有尽有。• 接口调试运行，可以对参数进行加密，从 md5 到 aes 一应俱全，返回参数与模型实时分析对比，给出不一致的地方，找出接口可能出现的问题。如果你不想手写文档，那么试试接口的数据生成功能，可以对接口运行的数据一键生成文档信息。• mock 的无缝整合，DOClever 自己就是一个 mock 服务器，当你把接口的开发状态设置成已完成，本地 mock 便会自动请求真实接口数据，否则返回事先定义好的 mock 数据。• 支持 postman，rap，swagger 的导入，方便你做无缝迁移，同时也支持 html 文件的导出，方便你离线浏览！• 项目版本和接口快照功能并行，你可以为一个项目定义 1.0，1.1，1.2 版本，并且可以自由的在不同版本间切换回滚，再也不怕接口信息的遗失，同时接口也有快照功能，当你接口开发到一半或者接口需求变更的时候，可以随时查看之前编辑的接口信息。• 自动化测试功能，目前市面上类似平台的接口自动化测试大部分都是伪自动化，对于一个复杂的场景，比如获取验证码，登陆，获取订单列表，获取某个特定订单详情这样一个上下文关联的一系列操作无能为力。而 DOClever 独创的自动化测试功能，只需要你编写极少量的 javascript 代码便可以在网页里完成这样一系列操作，同时，DOClever 还提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能，你可以及时获取接口的运行状态。• 团队协作功能，很多类似的平台这样的功能是收费的，但是 DOClever 觉得好东西需要共享出来，你可快速开始- 4 -本文档使用 看云 构建以新建一个团队，并且把团队内的成员都拉进来，给他们分组，给他们分配相关的项目以及权限，发布团队公告等等。快速开始- 5 -本文档使用 看云 构建序言DOClever-移动时代首选接口管理平台！DOClever是一个可视化接免费开源的口管理工具 ,可以分析接口结构，校验接口正确性， 围绕接口定义文档，通过一系列自动化工具提升我们的协作效率。DOClever前后端全部采用了javascript来作为我们的开发语言，前端用的是vue+element UI，后端是express+mongodb，这样的框架集成了高并发，迭代快的特点，保证系统的稳定可靠。主要特性：• 可以对接口信息进行编辑管理，支持 get,post,put,delete,patch 五种方法，支持 https 和 https 协议，并且支持 query，body，json，raw，rest，formdata 的参数可视化编辑。同时对 json 可以进行无限层次可视化编辑。并且，状态码，代码注入，markdown 文档等附加功能应有尽有。• 接口调试运行，可以对参数进行加密，从 md5 到 aes 一应俱全，返回参数与模型实时分析对比，给出不一致的地方，找出接口可能出现的问题。如果你不想手写文档，那么试试接口的数据生成功能，可以对接口运行的数据一键生成文档信息。• mock 的无缝整合，DOClever 自己就是一个 mock 服务器，当你把接口的开发状态设置成已完成，本地 mock 便会自动请求真实接口数据，否则返回事先定义好的 mock 数据。• 支持 postman，rap，swagger 的导入，方便你做无缝迁移，同时也支持 html 文件的导出，方便你离线浏览！• 项目版本和接口快照功能并行，你可以为一个项目定义 1.0，1.1，1.2 版本，并且可以自由的在不同版本间切换回滚，再也不怕接口信息的遗失，同时接口也有快照功能，当你接口开发到一半或者接口需求变更的时候，可以随时查看之前编辑的接口信息。• 自动化测试功能，目前市面上类似平台的接口自动化测试大部分都是伪自动化，对于一个复杂的场景，比如获取验证码，登陆，获取订单列表，获取某个特定订单详情这样一个上下文关联的一系列操作无能为力。而 DOClever 独创的自动化测试功能，只需要你编写极少量的 javascript 代码便可以在网页里完成这样一系列操作，同时，DOClever 还提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能，你可以及时获取接口的运行状态。• 团队协作功能，很多类似的平台这样的功能是收费的，但是 DOClever 觉得好东西需要共享出来，你可序言- 6 -本文档使用 看云 构建以新建一个团队，并且把团队内的成员都拉进来，给他们分组，给他们分配相关的项目以及权限，发布团队公告等等。在线帮助：产品官网：视频帮助：官网Q群：611940610开源地址：Github: 码云: 序言- 7 -本文档使用 看云 构建快速创建项目现在我们要开始创建第一个项目了，准备好了吗？1、登录后台后点击右上角“添加--添加项目”按钮2、点击后会弹出如下界面：名称：该项目的名称描述：该项目的说明，如该项目的简单描述至此，您已经知道怎么创建一个项目了吧？快速创建项目- 8 -本文档使用 看云 构建快速创建项目- 9 -本文档使用 看云 构建快速创建接口上个章节，我们已经学会该如何简单的创建一个项目了；这节来带大家快速创建一个接口！创建完项目后，会出现，我创建的：点击项目后会出现如下界面：快速创建接口- 10 -本文档使用 看云 构建DOClever默认会创建两个分组：回收站 和 未命名我们点击未命名分组，会弹出一个下拉框，我们点击新建接口；点击新建接口后，右边会出现如下界面我们根据上图图示，填写您的接口名称等信息，就可以快速创建一个接口了,举个例子 创建登录接口1.填写接口的信息:名称，路径，接口方法，分组，状态以及简介2.接口的方法是GET 入参的填写快速创建接口- 11 -本文档使用 看云 构建3.接口的方法是POST 入参的填写4.接下来是出参 快速创建接口- 12 -本文档使用 看云 构建接下来就可以愉快的使用doclever接口管理平台了快速创建接口- 13 -本文档使用 看云 构建详细使用基础接口管理接口调试项目设置自动化测试版本管理团队协作总后台管理详细使用- 14 -本文档使用 看云 构建基础注册登录创建工程项目分类基础- 15 -本文档使用 看云 构建注册登录第一步：当你进入DOClever首页的时候，请点击注册按钮。第二步：在注册页面填写相关注册信息，点击注册按钮完成注册。注册登录- 16 -本文档使用 看云 构建第三步：注册成功后会跳转到登陆界面，填写用户名和密码，进入项目列表页。注册登录- 17 -本文档使用 看云 构建注册登录- 18 -本文档使用 看云 构建创建工程普通创建第一步：在项目列表页的右上方有创建按钮，我们在下拉菜单选择第一个创建项目第二步完成项目名称和描述的填写，点击确定，在页面上面便会出现我们刚才创建的项目了。创建工程- 19 -本文档使用 看云 构建导入DOClever目前支持4中内外部JSON格式的导入：postman v2导出JSON，DOClever导出JSON，RAP导出JSON，Swagger导出JSON1.postman导入将postman json的内容复制到文本框中，然后将改工程的baseurl（接口的根路径）填入下方输入框，可以填入多个，如果选中忽略大小写，这样在解析json的过程中就对baseurl的大小写不敏感了！点击保存，导入成功！创建工程- 20 -本文档使用 看云 构建2.DOClever 导出JSON导入可以将DOClever工程导出JSON导入为新的工程，常用于DOClever项目的迁移和备份。3.RAP导入创建工程- 21 -本文档使用 看云 构建这里要注意的一点，对于post这样的需要传body的接口，在导入的底部有一个body type，选择我们需要的body type，DOClever会将工程解析为相应的格式。4.Swagger导入Swagger导入分为两种，一种是通过swagger的json url来导入，还有一种是通过json来进行导入，在目前的版本中，swagger url导入后的工程会托管其url来更新工程，这样当swagger有更新的时候就可以将其DOClever工程保持同步。创建工程- 22 -本文档使用 看云 构建创建工程- 23 -本文档使用 看云 构建项目分类在项目列表中，可以将项目分为三种类型：我创建的，我加入的，公开。我创建的：这个分类里面都是有用户本人建立的项目，用户对改项目拥有绝对的权限。我加入的这个分类里面是由别个用户建立的项目，用户参与到该项目中的。公开这个是所有的注册用户都可以看到的项目，但是对该项目只有浏览的权限。项目分类- 24 -本文档使用 看云 构建接口管理创建接口接口编辑接口分组注入接口管理- 25 -本文档使用 看云 构建创建接口第一步:在项目列表页点击进入我们刚才创建的test项目，会来到项目主页这里来详细说明下左上角的这里是项目快速切换下拉框，在这里你可以快速切换你的项目。中间位置是项目的几个功能的tab，接口就是接口的处理页面，测试就是自动化测试页面，全局里面可以设置项目的各种全局变量，设置可以对项目的各项功能参数进行设置，版本可以对项目进行版本处理。创建接口- 26 -本文档使用 看云 构建这个区域是接口列表，右边有三个按钮，第一个是导入DOClever的分组JSON（这个JSON是有已有的分组导出的），第二个是新建分组，第三个是搜索接口。然后看列表，每个新建的项目（导入的除外）都有回收站和未命名两个分组，最上面红色的是接口的回收站，这个和电脑的回收站类似，都是待删除的接口会移动到这里面来，而下面的未命名，你可以根据需要修改该分组的名称，在其分组下可以新建接口！我们将鼠标移动到未命名分组上，其右边会出现编辑的图标，移动上去，选择新建接口创建接口- 27 -本文档使用 看云 构建这时在屏幕页面的右侧会弹出接口页面，等待我们输入保存。创建接口- 28 -本文档使用 看云 构建我们输入接口的基本信息，点击保存，在接口列表页便会出现我们新创建的接口创建接口- 29 -本文档使用 看云 构建接口编辑我们再次点开info这个接口，来详细的给大家说明下如何去编辑一个接口上图中接口编辑页面可以分为三个部分：接口的基本信息，接口快照，接口的参数信息。基本信息：名称