有没有办法从 json-server 文件生成 swagger.json

Posted 2023-03-27

【中文标题】有没有办法从 json-server 文件生成 swagger.json

【英文标题】：Is there a way to generate swagger.json from json-server file

【发布时间】：2018-07-23 16:44:46

【问题描述】：

对于原型设计，我们使用 json-server 库来创建基于我们的 db.json 文件的假 REST api。现在我们想使用 swagger。

所以我的问题是，有没有办法从我们的 db.json 文件生成 swagger.json？

如果没有，你们知道一些工具可以轻松生成 swagger.json 文件吗？

谢谢！

【参考方案1】：

如果您可以对“假”API 进行 API 调用，则可以使用 Swagger Inspector 创建 API 定义 (swagger.json)！步骤：

转到https://inspector.swagger.io。您应该创建一个帐户以继续执行后续步骤。 调用您的虚假 API。 选择调用并选择 CREATE API DEFINITION。 按照提示命名 API 等 您最终会进入一个包含 swagger.json 文件的文本编辑器（您可以复制文本或下载文件）。

瞧！

不用担心，如果您不想公开您的 API（公开是免费帐户的唯一选择），您可以立即从 SwaggerHub 中删除您的 API 文件。