OpenAPI 设计优先 API 参考

问题描述 投票:0回答:2

我正在尝试使用 OpenAPI 格式 (v2) 记录 REST API 参考。 我希望它是“设计第一”,这意味着我的 swagger 规范将成为 API 实现的契约。

我尝试了很多模块和解决方案,例如swagger-node(对文件夹结构和实现过于固执),swaggerize-express迫使我使用express等。我也尝试过generator-openapi-repo,但它似乎已经过时并且不再维护。

是否有任何解决方案可以记录 REST API 参考、设计优先且无需将文档与实际实现相结合?

swagger swagger-node
2个回答
0
投票

您可以将 swagger-node 用作本地编辑器。使用这些命令,运行 swagger 编辑器并编写您的 swagger 规范:

npm install -g swagger

swagger project create my-app

swagger project edit

设计完成后,

swagger.yaml
中存储的
api/swagger/
文件可用于任何实现。

如果您正在寻找在线编辑器,检查这些工具可能会有所帮助。


0
投票

您可以使用 ChatGPT - OpenAPI / Swagger 根据您的数据定义创建 OpenAPI (v2) REST API。

如何

1). 解释 ChatGPT - OpenAPI / Swagger 您的数据定义。

示例:

Entity_1

  • Column_1:数据类型
  • Column_2:数据类型
  • Column_3:数据类型

Entity_2

  • Column_1:数据类型
  • Column_2:数据类型
  • Column_3:数据类型

[...]

2). 您应该获得一个链接,其中包含从自定义 ChatGPT 生成的全面 OpenAPI v2 JSON。 此处解释了生成的 REST API 结构API 文档

3). 如果需要,请在 Swagger Editor 中编辑 swagger.json。

4)。根据 swagger.json 合约实现 REST API。

结论

  • 这遵循设计第一原则。
  • 在实现之前您会获得API描述。
  • 并且您不会被迫在实现中使用任何模块。
© www.soinside.com 2019 - 2024. All rights reserved.