swagger - OpenAPI 设计优先 API 参考

Question

我正在尝试使用 OpenAPI 格式 (v2) 记录 REST API 参考。我希望它是“设计优先”的，这意味着我的招摇规范将成为 API 实现的合同。

我已经尝试了许多模块和解决方案，例如swagger-node（对文件夹结构和实现过于依赖），swaggerize -express迫使我使用 express 等。我还尝试了generator-openapi-repo，但它似乎已经过时并且不再维护.

有什么解决方案可以记录 REST API 参考、设计优先且不将文档与实际实现结合起来吗？

Answer 1

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

npm install -g swagger

swagger project create my-app

swagger project edit

完成设计后，swagger.yaml存储在 中的文件api/swagger/，可用于任何实现。

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

• 简单的编辑器：editor.swagger.io
• 协作编辑器（提供免费和付费版本）：swaggerhub.com