在这前后端分离大行其道的今天,如何优雅的管理接口,对应提高工作效率非常重要。而接口又是由后端提供的,这个任务自然而然的又落在后台开发人员的身上。在这里提供三种常见的接口管理方案,这三种方案没有属谁最优,属谁最差。根据项目的情况而定。
内嵌接口服务
把在线接口文档内嵌到应用服务里,最流行的当属 Swagger 框架。Swagger 框架与Spring 框架完美集合,使用非常方便。
Swagger 是一个大型的 AP I开发者的工具框架,Swagger 框架有三大核心部分:提供了一个编写 API 文档的规范 ,称为 OAS ,在规范中明确API的格式和一些编写要素;提供相关的工具,对 API 文档的编写提供辅助。主要是这么几个项目 Swagger Editor、SwaggerUI、Swagger Codegen、Swagger Inspector;提供对各种流行语言和框架的集成,例如,集成 SpringMVC 的 springfox 框架。
基于文档式的接口管理
基于文档式的接口管理时最传统,也是最常见的接口管理方式。因为一直做些不大不小的项目型项目,所以几乎使用的都是该接口管理方案。文档格式多种多样,常见的文档格式有:电子表格Execl、电子文档Word、PDF文件。这种方案比较难控制版本,每次修改接口时,都需要同步更新接口文档。否则就造成接口与接口文档不一致。
独立接口平台
现在越来越多的公司提供开放平台,所以独立接口平台变得越来越常见了。比如,微信公众平台接口文档、微信小程序接口文档。这种方案有非常多的选择方案。