随着开发的推进,各种各样的文档会接踵而来,比如:需求文档、架构文档、接口文档等等,我们通过 SVN、Git 等可以很方便的管理,面对需求的不断变化,我们需要不断的对各类文档进行维护。但在开发阶段,针对接口文档而言,其具有不确定性、难维护、难测试等特点,接口的管理往往成为了难题。
今天我们带着 API 接口管理的问题,一起来看看一款可视化接口管理平台 YApi,让能轻松帮助我们搞定 API 的管理问题。
YApi 介绍
YApi 是高效、易用、功能强大的 API 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
在开始之前,可以先体验一把,体验地址:https://yapi.baidu.com
特性
可视化接口管理,基于 Websocket 的多人协作接口编辑功能和类 Postman 测试工具,让多人协作成倍提升开发效率。
扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性。
自动化测试, 完善的接口自动化测试,保证数据的正确性,并支持对 Response 断言。
Mock Server,易用的 Mock Server,方便 Mock 数据的生成。除支持普通的随机 Mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据。
数据导入导出,支持导入 Swagger, Postman, HAR 数据格式,导出 HTML, Markdown, JSON 数据格式, 方便 API 接口文档的迁移及归档。
插件机制,强大的插件机制,满足各类业务需求,便于扩展对接等。
基于 JSON5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍。
免费开源,支持二次开发,内网部署,信息安全可靠。
谁在用
去哪儿
携程
艺龙
美团
百度
腾讯
阿里巴巴
京东
今日头条
唯品支付
链家网
快手
便利蜂
中商惠民
新浪
VIPKID
马蜂窝
认识 YApi
在开始使用 YApi 之前,我们先来熟悉一下 YApi 的网站结构,这将让你快速了解YApi。
登录与注册:
想要使用 YApi ,首先要注册账号。
首页:
登录后进入首页,首页展示了分组与项目。
此时你作为新用户,没有任何分组与项目的权限,因此只能搜索、浏览 “公开项目” 的接口,如果在首页找不到任何项目,请联系管理员将你加入对应项目。
首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。
首页左侧展示分组信息,“分组”是“项目”的集合,只有超级管理员可以管理分组。
首页右侧是分组下的项目和成员列表,点击左侧的某个分组,右侧会出现该分组下的项目和成员信息。
点击项目右上角的星星即可关注项目,关注的项目可以在“我的关注”页面查看。