关于javascript:如何更好管理-Api-接口续

哈喽，我是树酱。去年中旬的时候写过一篇对于如何更好治理 Api 接口。最近有敌人问我，咱们都是依据Swagger文档，而后通过“浏览”swagger文档中每个微服务蕴含的CRUD(增刪查改)等API，再通过“手动”撸出各种service文件，以此达到封装的后果。然而这样会裸露一些问题，如下

那有什么方法能够解决上述的问题？
办法是有的，实质上通过程序自动化去生成各种service文件，解放双手。那具体怎么做呢？咱们能够通过解析swagger接口文档的构造

在聊解析文档之前，咱们首先须要先理解一下 OpenAPI

OpenAPI标准，也称作OAS，是一种API文档规范

通过 OpenAPI 标准来定义您的 API，您就能够用文档生成工具来展现您的 API，甚至能够应用代码生成工具来主动生成各种编程语言的服务器端和客户端的代码。

啊乐同学：那openAPI与swagger之间有是什么关系？

OpenAPI 始于 Swagger 标准，Swagger 标准已于2015 年捐献给 Linux 基金会后改名为 OpenAPI，并定义最新的标准为 OpenAPI 3.0

实质上你能够了解为前者是标准，后者则是实现标准的工具

啊乐同学：那么一个通过OpenAPI标准实现的对象是什么样子的呢？

具体次要包含以下这些字段信息（指的是OpenAPI 3.0）

如果你想实时预览OpenAPI在线编辑的成果，能够尝试应用 Swagger Editor

啊呆同学：我看有两种标准，OAS2与OAS3，这两种有什么区别呢？

OAS2是Swagger2的简称，上文提到，自 Swagger 标准募捐给linux之后，将Swagger标准重命名为OpenAPI标准，就是咱们提到的OAS3。下图是两者的辨别

举荐浏览：

梳理完OpenAPI标准构造，接下来咱们就须要通过解析OpenApi文档构造来生成咱们的service文件

我在社区找到目前的两种解决形式

umijs封装了一个openapi插件，通过输出一个 openapi 的标准文件，就能够实现自动化创立service。

这个标准文件咱们在通过swagger-ui的界面中能够获取

而后把这个复制swagger的url到openapi的配置中（schemaPath参数），能够参考下图

而后执行命令行就能够主动生成以下目录构造serves

这里以宠物商店的DEMO API 文档为例，看下生成的接口封装成什么样子

同时在serves中咱们也会生成 typings.d.ts 文件，蕴含了openapi中的定义

目前该工具的劣势在于，重度绑定了umi且对中文反对不敌对。如果你感觉不适宜外部的技术栈，能够参考该工具的实现思路，而后在它的根底上本人造轮子

OpenApi社区开源了OpenApi Generator，咱们能够通过 OpenAPI Generator，通过提供OpenAPI 标准(上文提到的OAS2和OAS3)来主动生成 API 客户端库、文档及配置。

比方咱们前端依赖axios作为申请库，那么咱们能够通过指定类型来生成ts+axios的申请相干的代码

具体应用请查阅 github - openapi-generator

如果你是前端并且对java并不相熟的童鞋，间接应用会收到技术栈限度，因为它提供的是一个JAR包，尽管也有提供cli工具，然而只反对yml格局解析

那么有没有更编辑的形式，能够不依赖环境去应用呢？

这里提供一个工具，不便你间接应用: Apifox

Apifox不仅反对mock性能和接口调试，我发现还有个代码生成性能，代码生成引擎应用的也就是咱们提到的openapi-generator，能够依据接口/模型定义，主动生成各种语言/框架（如 TypeScript、Java、Go、Swift 等130 种语言及框架）的业务代码，比方接口申请代码

上图是Apifox的生成代码的界面，这里以TypeScript语言+axios申请库为例，咱们还能够抉择咱们导出的代码蕴含的内容，比方只须要仅接口代码或仅模型等

如果你有更好的实现形式，也能够在评论区留言，也能够加我微信，咱们一起喝茶探讨