OneAPI 的名字由 One、API 2 个单词组合而来,寓意为最后一个 API 解决方案 😎
OneAPI 是一个能 💯 替代 springdoc-openapi/Swagger 的 API 生产工具,既不需要修改后端代码,也不需要启动应用。 也支持导出 OpenAPI 3.0 协议数据,方便在其他工具中消费(如接口管理平台/Postman 等)。
如图所示,在 API 生命周期中 OneAPI 的定位是 API 生产,与业界的接口管理平台或 Postman 等工具处于不同阶段。
OneAPI 早期版本中底层实现也曾基于 Swagger,当我们在支付宝后端推广时遇到几个比较大的问题:
OneAPI 当前版本基于 AST 实现,相比 Swagger 有以下优势:
目前探索出基于 OneAPI 的 API 生产/消费最佳实践流程如下: