接口文档,顾名思义就是对接口说明的文档。好的接口文档包含了对接口URL,参数以及输出内容的说明,我们参照接口文档就能编写出一个个的测试用例。而且接口文档详细的话,测试用例编写起来就会比较简单,不容易遗漏。

如果接口文档信息不全或是没有接口文档的情况下,领导要求我们做接口自动化测试,这无异是一个非常艰辛的任务。但是编写接口文档的工作量很大,怎么办呢?有什么自动化工具可以协助我们生成文档呢?

众里寻他千百度,最近我发现一款工具可以大大解放我们工作,自动生成接口文档。他就是YApi,先上图说明,这是我在YApi中做的接口文档,是不是蛮专业

YApi介绍

1 YApi 是什么呢

YMFE 是去哪儿网移动架构组(YMFE)简称,是由FE,iOS和Android工程师共同组成的

• Yapi 由 YMFE开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。

• YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求

• 基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率

• Mock Server 易用的 Mock Server,再也不用担心 mock 数据的生成了

• 自动化测试 完善的接口自动化测试,保证数据的正确性

• 数据导入 支持导入 swagger, postman, har 数据格式,方便迁移旧项目

2 试用地址如下

http://yapi.demo.qunar.com/

3 这是一个Mock接口数据维护例子

4 更为强大的是,可以支持数据导入,和文档导出,可以把项目中的接口导出到HTML文件,同时在本地word中,就可以将HTML文档转换为word文档,更方便我们转播和存储。

安装使用

5如何安装呢,直接采用docker安装最为简单(需要有docker使用基础)

5.1 安装mogodb;

docker run -d --name mongo-yapi mongo;

5.2 拉取yapi

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

5.3、初始化管理员账号和服务

docker run -it --rm

--link mongo-yapi:mongo

--entrypoint npm

--workdir /api/vendors

registry.cn-hangzhou.aliyuncs.com/anoy/yapi

runinstall-server

5.4、初始化管理员账号和服务

启动YApi服务

docker run -d

--name yapi

--link mongo-yapi:mongo

--workdir /api/vendors

-p 3002:3000

registry.cn-hangzhou.aliyuncs.com/anoy/yapi

server/app.js

5.5、访问http://ip:3002

6 mock平台不足地方,如果涉及后台业务,比如查询数据库 ,java方向可以采用springmvc 自己定制,这就需要具备测试开发能力了,例如自定义动态返回接口

yapi接口导出为word_还在手工写接口测试文档,已经out了相关推荐

  1. postman测试websocket_还在手工写接口测试文档,已经out了

    谢谢打开这篇文章的每个你关注我们 点击右上角 ··· 设为星标 接口文档,顾名思义就是对接口说明的文档.好的接口文档包含了对接口URL,参数以及输出内容的说明,我们参照接口文档就能编写出一个个的测试用 ...

  2. java先删后保存数据库据功能,还在手工生成数据库文档?3个步骤自动完成了解一下...

    自动化生成数据库文档,简单的3个步骤即可完成,了解一下. 1 前言 平时工作中,大家应该都会遇到需要导出数据库说明文档(也叫数据字典)的情况,即把各数据表的字段信息整理成一个个的表说明,然后用 exc ...

  3. 还在发愁写API文档?推荐一款阿里腾讯都在用的API管理神器!

    欢迎关注方志朋的博客,回复"666"获面试宝典 前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...

  4. yapi接口导出为word_接口文档神器YApi

    什么是YApi 官网上是这么介绍的:YApi 是一个可本地部署的.打通前后端及QA的.可视化的接口管理平台 https://hellosean1025.github.... 可以这么说YApi兼具sw ...

  5. VUE导出含(charts)图表的word文档

    项目场景: 关于VUE导出含(charts)图表的word文档 问题描述: 由于项目需求要导出数据,开始做的PDF,但是后期考虑到,PDF无法编辑的问题,需要以word文档的形式展示,开始之前需要安装 ...

  6. 网页导出pdf不完整_快速翻译PDF文档的免费方法

    您还在为翻译PDF文档而烦恼吗? 或者您通过某度搜索出来的文档翻译网站或者使用某些文档软件都需要注册会员或者充钱呢? 而且好多既不安全还不一定靠谱. 本文介绍的这种方法希望能够为您解决烦恼.此方法不涉 ...

  7. 前端页面预览word_前端实现在线预览文档

    前端实现在线预览文档 发布时间:2019-06-03 17:22, 浏览次数:529 <>前端实现在线预览文档 最近项目开发中需要实现在线预览Word,Excel,PowerPoint格式 ...

  8. 写word文档时计算机的工作原理,写word文档时还没保存电脑就死机如何恢复

    电脑已经成为人类生活中不可缺少的一部分,人们利用电脑可以轻松的完成以前需要大量劳动力才能完成的工作,但在人们在使用电脑中也会遇到很多的麻烦,比如死机,这些原因烦恼着每一个电脑用户,这不,最近就有小伙伴 ...

  9. 你还在用收费的文档管理工具?我这有更牛逼的选择!完全免费

    点关注公众号,回复"1024"获取2TB学习资源! 今天给大家分享一款免费开源的在线文档管理工具 MinDoc ,提升 IT 部门的文档管理效率. 概述 MinDoc 是一款针对 ...

最新文章

  1. 服务器维护10月11魔兽,魔兽世界10月11日更新内容是什么_10.11PVP改动预览_3DM网游...
  2. 企业云部署要如何选择IaaS PaaS和SaaS
  3. Spring中ClassPathXmlApplicationContext类的简单使用
  4. 基于nginx-rtmp实现电视回看业务
  5. Linux磁盘分区及要求
  6. 神奇的python(三)之Python扩展C/C++库(C转换为Python)
  7. Scrapy框架(持久化,去重,深度控制,cookie)
  8. C++ - 操作运算符
  9. devgis分享 只分享有价值的东西!http://download.csdn.net/user/devgis
  10. (转载)oracle10g在win10上的安装
  11. [原创]我眼中的乔布斯
  12. memtester --转载
  13. PointGet的一生
  14. SMM框架学习日志——Spring详述
  15. linux中pid,tid, 以及 真实pid的关系
  16. dlib.get_frontal_face_detector(), Python format 格式化函数 predictor(img, dets[0])
  17. 谱标科技二手分析仪器租赁流程
  18. 如何在JavaScript中循环遍历JSON响应?
  19. VC6环境下使用图形控件NTGraph的方法和步骤
  20. 三星sec.android.soagent,【图片】(原贴删)原不用ROOT禁用系统软件的方法,加详细教程。【note4吧】_百度贴吧...

热门文章

  1. android cpu负载 工具,【专家专栏】Android性能测试之CPU
  2. springboot2.0.5集成mybatis(PageHelper分页插件、generator插件使用)
  3. 浅谈关于申请CCC认证以后的好处
  4. UVA10118(记忆化搜索 + 好题)
  5. ERES BRES的区别
  6. 2016年互联网面试总结
  7. 原生Hadoop环境下安装Hue
  8. Latex 参考文献格式
  9. 1.NR中PointA、Offsettocarrier、RIV等计算
  10. Python:元组使用