有资源网

搜索
有资源网 首页 编程语言 查看内容

需要接口管理的你了解一下?

2019-7-26 01:07| 发布者: admin| 查看: 217| 评论: 0

摘要: YApi 使用指南 前言 在一样平常的开发模式里,前端负责页面和动态脚本的处理,服务端负责业务逻辑和接口的实现。当前端需要服务端提供的接口实现动态数据展示和交互时,服务端完成接口开发后会提供一个接口文档给到

YApi 使用指南

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(1)

前言

在一样平常的开发模式里,前端负责页面和动态脚本的处理,服务端负责业务逻辑和接口的实现。当前端需要服务端提供的接口实现动态数据展示和交互时,服务端完成接口开发后会提供一个接口文档给到前端按照文档规范再进行开发。如许模式下往往会出现两种情况:一种是往前端开发的进度往与服务端开发的进度不会完全同步,这就存在了一方等待另一方的情况,这多少会影响整体项目开发进度;另一种就是当前端对接差别的服务端人员所开发的接口,假如没有了同一的接口文档规范,每个人输出的接口文档都不尽雷同,在后期对项目接口的更新和维护会是很大的时间成本。

以是很有必要有一个前后端通用的接口管理平台,简化接口对接和维护的流程。前后端可以通过接口管理平台,订定接口数据和格式,然后通过模拟数据天生假接口,前后端再各自独立开发,直至双方都开发完成后对接真实接口数据进行微调即可。并且通过接口管理平台,开发人员可以更便捷地管理项目全部接口数据。

这里本文将主要认识学习一下目前国内开源较火的接口管理平台 YApi,看如何使用它资助我们进步开发服从和便捷对接口的管理。

本文不会形貌 YApi 的安装摆设过程,想要具体了解如何摆设YApi可以参见文末提供的参考链接:YApi 安装摆设使用 Docker 构建 Yapi

YApi 先容

YApi 是一个可本地摆设的、买通前后端及QA的、可视化的接口管理平台,以开发、产品、测试人员提供更优雅的接口管理服务为目标,该项目由去哪儿网大前端技术团队开源的,托管在 Github 上,已经 9000 多星。

YApi 作为 API 管理平台主要提供三大块功能:

  • 项目管理:提供根本的项目分组,项目管理,接口管理功能,成员权限管理

  • 接口管理:提供友好的接口文档,支持多人协作接口编辑功能,以及类 Postman 测试工具便于高效调试接口

  • Mock 服务:基于Mock.js,通过随机数据天生,模拟各种接口数据,充分发挥前后端分离的优势。

什么是Mock.js

Mock.js是一个模拟数据天生器,资助前端开发和原型与后端进度分离,镌汰一些单调,特别在编写自动化测试时。

--- mock.js那点事(上)

固然 YApi 尚有很多强大的功能,好比自动化测试,插件机制,二次开发等等。

下图是YApi 官方提供了使用 YApi 的工作流程,从这里可以简单了解下如安在一样平常开发中使用 YApi。

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(2)

第一个 YApi

登录注册

使用 YApi 前,必须要先有登录账号,以是一开始需要在所搭建的 YApi 网站上注册一个账号,注册乐结果可以用用户名大概邮箱进行登录。

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(3)

注册乐成后就会自动登录进入 YApi 首页,后面再次使用就可以直接用账号登录了。

需要留意的是作为新注册的用户,没有任何分组与项目的权限,只能对“公开项目” 的接口进行搜刮、欣赏 ,此时需要联系平台管理员将你加入对应项目。

下图为一个正常账户登录 YApi 首页的根本内容:

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(4)

  1. 首页头部展示了当前地点的位置、搜刮框、新建项目、查察文档和用户信息。

  2. 首页左侧展示分组信息,“分组”是“项目”的聚集,只有超级管理员可以管理分组。

  3. 首页右侧是分组下的项目和成员列表,点击左侧的某个分组,右侧会出现该分组下的项目和成员信息。

  4. 点击项目右上角的星星即可关注项目,关注的项目可以在“我的关注”页面查察。

  5. 点击头像进入“个人中央”,允许查察和修改个人信息。

项目接口

起首在项目列表选择一个项目进入(假如没有可用的项目,一种方式是找管理员分配项目权限,一种是在左上角点击 "添加项目" 新建一个项目),进入项目后可大致看到如下内容:

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(5)

  1. 接口列表,展示该项目的全部接口名称,并且按照文件夹分类,默认都在公共分类下,也可以自定义添加分类。

  2. 测试聚集,用于保存接口运行正常的数据信息和接口状态,便于后续直接使用测试聚集中的接口测试。

  3. 添加接口,为项目添加接口,默认在公共分类下,需要指定接口名,哀求方式和接口路径,保存后自动添加到接口列表下。

  4. 用于接口数据的导入导出,便于接口数据的迁移归档。

  5. 对项目信息的根本设置,如情况地点,接口路径,Mock 设置等。

如今我们再来看下一个简单接口的页面展示内容:

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(6)

接口信息框内有四个面板可以切换,分别为预览,编辑,运行和高级 Mock,我们在编辑面板里可以通过接口的哀求方式,哀求数据,响应数据,接口形貌等信息进行编辑,保存后都会在预览面板内清晰展示出来,当需要进行接口测试时就需要在运行面板里操纵,内里的操纵方式跟 Postman 很相似,相信使用过 Postman 的小同伴应该能很快上手。

留意:使用接口测试服务时,假如是 Chrome 欣赏器 ,需安装测试加强插件,官方也提供了下载地点和安装教程。

这里有一个小本领可以分享下:每次进入接口的运行面板,前次使用哀求参数都会被情况,每次都需要重新填写,假如哀求接口参数一多就非常繁琐;这里我们可以把测试过的接口通过保存按钮加入到测试聚集中,后面可以直接在测试聚集中找到所记载的接口和有效的哀求参数,并且能直接使用。

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(7)

高级Mock 一栏则是对接口模拟数据的设置,具体用法在后面会具体先容。

到这里,YApi 的简单使用先容完毕,使用 YApi 进行根本的接口测试和维护应该问题不大了,后续先容 YApi 的更高级用法和最佳实践。

Mock 接口

本节主要形貌如何通过 YApi 的 Mock 服务模拟接口的数据。

起首在接口面板里选择高级Mock一栏,选择添加盼望来定义所实现模拟的条件和数据。

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(8)

添加盼望时分为两部门,一块是填关于盼望的根本信息,如名称,白名单IP,匹配的参数等,别的一块就是盼望模拟的响应数据,如响应头信息,响应体数据,以致响应时间也可以设置。

在这里设置响应体数据时,除了使用常规的固定假数据返回,我们可以使用 Mock.js 支持的语法,让假数据随机天生,例如下方的示例模拟一个简单的响应数据: code 为 200 大概 400,message 为重复出现 1~10次的测试两次。

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(9)保存之后,我们对接口的 Mock 地点(预览面板中 Mock 地点链接)进行多次哀求就随机得到以下的哀求数据:

 {
"code": 200,
"message": "测试测试测试",
"data": {}
}

{
"code": 400,
"message": "测试测试测试测试测试测试",
"data": {}
}
  • Java 之 Lombok 必知必会

  • Java 开发看的 Scala 入门

  • Java 微服务新生代之 Nacos

  • Java 微服务新生代 Nacos 之设置管理

  • 把握计划模式之适配器模式

推荐阅读

  • YApi 安装摆设:https://hellosean1025.github.io/yapi/devops/index.html

  • 使用 Docker 构建 Yapi: https://www.jianshu.com/p/a97d2efb23c5

  • YApi 官方教程:https://hellosean1025.github.io/yapi/documents/index.html

  • Github 地点:https://github.com/YMFE/yapi

  • mock.js那点事(上):https://juejin.im/post/58f9eec0a22b9d00658ee4b7

参考

编程语言-免费yoqq需要接口管理的你了解一下?yoqq资源(10)

本文主要记载了开源接口管理平台- YApi的根本先容和使用。面临多人多项目的团队开发,有个同一的管理平台来进行接口管理和维护,还是很有必要的,也是很基础的,对项目的开发服从进步也有很大资助,假如你有正在使用 YApi 有更好的使用姿势大概遇到什么坑,更大概在使用过其他的接口管理平台框架,也欢迎留言互换讨论
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!


路过

雷人

握手

鲜花

鸡蛋

最新评论

返回顶部