一.为什么需要接口管理平台

在项目开发过程中,我们需要开发维护大量的接口。尤其是现在前后端分离模式的流行,需要我们在开发过程中维护大量的接口文档。当文档数量过多时,文档的维护难度也大大增大。所以使用一个方便的接口管理平台来管理我们的接口及其相关文档十分重要。

二.YAPI平台

1.YAPI平台简介

YAPI是由去哪儿网移动架构组(简称YMFE,一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开发的可视化接口管理工具,是一个可本地部署的、打通前后端及QA的接口管理平台。YAPI旨在为开发、产品和测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布和维护不同项目,不同平台的API。有了YAPI,我们可以很方便的测试、管理和维护多个项目的API接口,不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭),YAPI是一个独立的服务平台。

github地址:https://github.com/YMFE/yapi

帮助文档地址:https://yapi.baidu.com/doc/documents/index.html

在线体验地址:https://yapi.baidu.com

2.YAPI平台的使用

(1)新建分组

分组是YAPI中的一个独立空间,在该分组内可以创建不同的项目,项目下可以创建接口。在该分组的成员可以根据不同的权限,编辑浏览接口内容。

接口整合平台架构图 接口管理平台作用_软件测试

(2)新建项目

接口整合平台架构图 接口管理平台作用_github_02

接口整合平台架构图 接口管理平台作用_github_03

(3)创建接口

创建接口

接口整合平台架构图 接口管理平台作用_接口_04

接口整合平台架构图 接口管理平台作用_软件测试_05


接口整合平台架构图 接口管理平台作用_python_06


接口整合平台架构图 接口管理平台作用_github_07

添加接口数据

接口整合平台架构图 接口管理平台作用_软件测试_08

接口整合平台架构图 接口管理平台作用_github_09

运行接口

接口整合平台架构图 接口管理平台作用_软件测试_10