一统江湖的大前端(3) DOClever——你的postman有点low

《一统江湖的大前端》系列是自己的前端学习笔记,旨在介绍javascript在非网页开发领域的应用案例和发现各类好玩的js库,不定期更新。如果你对前端的理解还是写写页面绑绑事件,那你真的是有点OUT了,前端能做的事情已经太多了, 手机app开发 , 桌面应用开发 , 用于神经网络人工智能的库 , 页面游戏 , 数据可视化 , 甚至 嵌入式开发 ,什么火就搞什么,活脱脱一个蹭热点小能手。如果你也觉得前端的日常开发有些枯燥,不妨一起来看看前端的另一番模样。

一统江湖的大前端(3) DOClever——你的postman有点low

Mock服务器 + Excel怎么了

如果你的开发进度还在被后端开发人员牵着鼻子走,请参考《一统江湖的大前端(2)—— Mock.js+Node.js如何与后端潇洒分手》,优化自己的开发工作流

有了Mock服务器和Excel的文档说明后,相信大家的沟通效率会比以前提升很多,但仍然被沟通占据着绝大部分开发时间,常常遇到的情况会有:

  • 没有注释信息,字段不宜对齐
    Mock服务器返回的只有数据,没有注释信息,即便后端开发人员有心把查到的信息重组为你需要的字段,但仍有可能因为无法对号入座而作罢。

  • 接口数量增加后难以管理
    简易的Mock服务器无法提供相应的接口文档,随着接口数量的增加,分分钟乱成一锅粥,总不能每次查个接口都是跑去翻Mock服务器的源代码然后看注释吧

  • 无测试支持
    MockJs只生成模拟数据,并无任何对自动化测试的支持

  • 满怀热情写了API文档,But没人看
    程序员大多没有Excel习惯,而且大家都很忙,忙到即便你提供了Mock接口以及相关的API说明,他们还是会再问你一遍关于接口的信息程序员习惯以自己熟悉的方式进行工作,而且一般默认这种效率最高

  • Excel版本的API文档方便交流,但不易更新
    一对一联调时候还好,但如果项目组内协作人员较多时,麻烦就来了,每当你更新或是增加接口信息时,就要重新给所有相关人员发送一次新的Excel文件,很不方便。

DOClever——前端开发的接口管理工具

一统江湖的大前端(3) DOClever——你的postman有点low

Java开发人员有Swagger,无严格保密性要求的可以尝试阿里的RAP,都是专业且强大的接口管理工具。当我们仅希望在内网中使用,或仅仅处于优化个人工作流的目的时,强烈推荐这块开源接口管理软件——DOCleverDOClever非常适合前端人员使用,VUE+express+mongodb编写,纯前端技术栈,能够实现团队管理接口管理文档管理自动化测试等功能,甚至可以根据接口返回数据自动生成接口文档的结构,方便智能。

无论你当前在做的项目是否有管理好相关的接口文档,作为开发人员,你都应该有自己的方式来管理好所有出自你手的接口

MockJs尚未失宠

  • 特殊场景
    DOClever自带的Mock工具可以按参数类型生成虚拟数据,对于开发人员交流已经够用了,但如果前台需要多条模式相同的数据时,就需要用到上一篇博客中提到的MockJs来生成,(DOClever自带的Mock语法貌似尚未支持循环生成雷同数据,除了自己修改源代码外,如果还有其他更方便的实现方法也请不吝赐教~),DOClever中可以设置多台Mock服务器的url地址,常见的协作需求中,两套数据基本够用了,一套方便快捷,配合核对接口,另一套需要自定义开发,配合实现各种前端展示需求。

DOClever的安装

安装需要的东西真的比较多,尤其是对于非前端人员而言。

  • 1.安装nodejs
    上一篇博客的附件中有nodejs V8.9的安装包
  • 2.安装mongodb
    mongodb的安装可以参考Windows环境下如何安装mongodb
  • 3.安装mongodb可视化管理工具(个人推荐robot3T)[可选]
  • 4.安装DOClever
    由于是开源项目,直接在github上下载DOClever,使用方法主页有很详细的说明,按步骤来部署就可以了。
    自己部署的图:

一统江湖的大前端(3) DOClever——你的postman有点low

开始DOCLever

  • 可视化的管理API
    • 界面左侧树形图式管理所有相关API,方便查找
    • 可视化界面直接填写API相关信息
    • 参数化填写request请求体
    • 参数化编写响应数据,支持无限层次嵌套

一统江湖的大前端(3) DOClever——你的postman有点low

  • 方便的Mock数据获取
    • 直接选择DOClever自带的mock服务器,可以方便地与协作人员沟通接口字段和结构
    • 选择自己搭建的Mock服务器,可以方便地获得更多模式相同的响应数据

一统江湖的大前端(3) DOClever——你的postman有点low

  • 自动化接口测试
    • 简易的自动化测试语法

一统江湖的大前端(3) DOClever——你的postman有点low

  • 自动化测试集计划任务
    • 定时跑任务自动化测试用例集
      一统江湖的大前端(3) DOClever——你的postman有点low

后记

别人开发的代码你可以不管,但出自你手的代码, 愿它们都是精品,易于查询,易于管理。

上一篇:一统江湖的大前端(2)—— Mock.js + Node.js 如何与后端潇洒分手


下一篇:一统江湖的大前端(4)shell.js——穿上马甲我照样认识你