yapi 通过 apicurio + swagger 导入插件实现基于 model 的 restful api 快速定义方法

gopyfrb3 于 2022-10-27 发布在其他

关注(0)|答案(4)|浏览(266)

通过 yapi 定义出接口其实是一件很 challenge 和重复的事情。

一般的我们的基于“资源”概念的 restful 接口会对某个数据模型(model)实现 CRUD 接口（增删改查）。

假设我们一个基本的管理用户的需求。

对于 yapi，意味着我们需要至少定义 5个接口，这些接口的 request 和 response 存在很大需要复用数据模型的需求。

最近找到一个工具，可以结合起来定义相关模型。

感觉有时间可以写个插件内置到 yapi 这部分功能。（咕咕咕）

4条答案

我一直有个疑问，都用yapi了，为什么还是很多人继续使用swagger?
或者说swagger的优势在哪里？哪些特点是yapi无法满足的?

简单来说：因为 swagger 更加强大。

swagger 拥有 open api spec （开放 API 声明规范）
已 open api spec 为基础，swagger 提供对整个API的开发周期都提供了相应的解决方案，是一个非常庞大的项目（包括设计、编码和测试，几乎支持所有语言）
open api spec 被广泛使用，有一套自己成熟的生态，社区比较活跃。而 yapi 目前的生态只有几个插件。目前可以利用 open api 生态，在社区找到各种各样的解决方案
yapi 导出的那份 json 格式你除了 yapi，哪里都不能用；而 swagger 定义的格式可以在 swagger-ui、导入 yapi、数据校验、postman（以前可以，现在 postman 似乎也是自己在干，暗中竞争）。既然一次定义可以多个地方使用，为何我不用 swagger
项目使用感受，yapi 不支持数据模型定义，restful api 需要多次定义重复的数据，维护非常蛋疼，直接劝退项目组大部分同学

@tangcent

@ghostbody ghostbody 插件写好了吗，期待

唉，搞起来极其麻烦。

为什么 yapi 不用开源的 OAS 建模，而要自己设计一套描述接口的数据结构，导致很多东西很难做，而且和开源生态脱离。目前只能数据导入、导出方式实现，非常麻烦。