先后端分离，几个经常使用的API管理系统

 为啥须要API管理系统！ 

互联网服务发展至今，做为开发者阵营的咱们，已经用实践证实了先后端分离开发模式正在逐渐成为愈来愈多互联网公司构建服务和应用的方式。

先后端分离优点多多，其中一个很重要的优点是：对于后台服务（系统）来说，只需提供一套统一的API接口，可被多个客户端所复用，分工和协做被细化，大大提升了效率。

与此同时带来的一些反作用即是：

• 接口文档管理混乱。以前不少公司管理API接口，有用Wiki的，有Word文档的，有Html的，常常遇到问题是接口因变了，好比增长参数，参数名变了，参数被删除了等都没有及时更新文档的状况

• 接口测试没有保障。毕竟前端开发依赖后端接口，若是先后端开发不一样步，接口及时测试成了问题，所以须要随时提供一套可用的API接口数据测试服务。

• 资源分散，难以共享。每一个开发者维护本身的一套测试接口集合，没法共用他人接口集合，开发过程当中充斥着大量重复造数据、填接口的工做，效率不高

• 其余问题。除此以外还有可能碰到诸如 文档导出、接口分类规划、操做便利性等一系列问题。

基于此状况，所以本文接下来就来推荐几个经常使用的 API管理系统，帮助先后端分离开发模式下提高效率和可靠性，总有一个你看得上！

---

 YApi （推荐）

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。它能够帮助开发者轻松建立、发布、以及维护API。除此以外，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操做就能够实现接口的管理。

功能特性：

• 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提高多倍

• 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性

• 相似 postman 的接口调试

• 自动化测试, 支持对 Response 断言

• MockServer 除支持普通的随机 mock 外，还增长了 Mock 指望功能，根据设置的请求过滤规则，返回指望数据

• 支持 postman, har, swagger 数据导入

• 免费开源，内网部署，信息不再怕泄露了

项目主页： http://yapi.demo.qunar.com/

文档：https://hellosean1025.github.io/yapi/documents/index.html

 

 

其余一些管理工具：

---

一、eolinker 

eolinker也挺好用，UI好看，是一个开箱即用的API研发管理方案，0代码实现API自动化

功能特性：

• 开箱即用的API研发管理方案：无需繁琐的配置，支持读取代码注解生成API文档，或者是经过UI界面快速建立全面的API文档。经过Mock API、API变动通知、版本管理等服务，让团队更敏捷。

• 强大的“0代码”API测试 / 自动化测试：全面支持HTTPS、Restful、Web Service等类型API。强大的API自动化测试和用例管理功能，让你不写代码实现API自动化测试，实时生成测试报告，提升测试覆盖率。

• 实用的团队协做功能：提供强大的人员权限管理功能，你能够为不一样的成员设置容许执行的操做，系统会自动记录成员的全部操做日志。而且能够经过丰富的插件系统来扩展示有的系统功能。

• 开放的平台设计：一键导入Postman、Swagger等产品数据，让您快速享受到EOLINKER API Studio的服务。您还能够经过Open API将EOLINKER API Studio对接到各种企业内部系统中，实现开发、测试、运维一体化。

• 支持离线的私有化部署：EOLINKER API Studio支持离线的私有化部署，产品以及数据均储存在企业内部，您能够根据部门/分公司设立相互隔离的工做空间，而且经过Open API对接Jenkins等各种持续集成系统。

项目主页： https://www.eolinker.com/

---

二、ShowDoc 

ShowDoc 是一个很是适合IT团队的在线文档分享工具，它能够加快团队之间沟通的效率。免费开源！

支持以下特性：

• API文档： 随着移动互联网的发展，BaaS（后端即服务）愈来愈流行。服务端提供API，APP端或者网页前端即可方便调用数据。用 ShowDoc能够很是方便快速地编写出美观的API文档。

• 数据字典： 一份好的数据字典能够很方便地向别人说明你的数据库结构，如各个字段的释义等。

• 说明文档： 你彻底可使用showdoc来编写一些工具的说明书,也能够编写一些技术规范说明文档以供团队查阅

项目主页： https://www.showdoc.cc/

---

三、易文档 

最后一个易文档也是，从需求文档、API文档、部署文档到使用手册，支持多种定制文档编辑器；同时也支持接口在线测试，一键生成文档、调用示例、mock配置。

 项目主页： https://easydoc.xyz/

---

 

四、Swagger

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。它能够方便地和 Spring MVC、Spring Boot等框架进行快速整合，而且经过结合诸如Swagger-UI等组件，将 controller层的方法进行方便地可视化展现，像方法注释，方法参数，方法返回值等都提供了相应的用户

项目主页： https://swagger.io/

 

原文地址：https://mp.weixin.qq.com/s/Ahs6fnIfFVVPOn3NZpIsNA