使用 Swagger 编辑器记录 REST API

Question

我必须使用 Swagger 编辑器为其中一个应用程序记录 REST API。我浏览了一些可用的参考资料，但似乎没有任何内容显示记录 API 的起点。

https://swagger.io/docs/swagger-tools/#installation-11

已下载 Swagger 编辑器并想开始记录。 任何开始的具体指针都会有所帮助。

谢谢。

问候， -纳扬·帕里克

Answer 1

我能够开始记录 API。以下是我遵循的步骤，希望这对有需要的人有所帮助。

使用 Swagger-Editor 记录

1. 在线打开 Swagger 编辑器https://editor.swagger.io/ 或
2. 从链接下载https://github.com/swagger-api/swagger-editor
3. 转到文件夹 swagger-editor 并运行 index.html
4. 这将打开编辑器并开始根据https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md 中提到的规范记录 API
5. 完成后，将其下载为 JSON 或 YAML 文件。

在 Swagger-UI 上查看

6. 从链接https://github.com/swagger-api/swagger-ui下载swagger-ui
7. 转到 dist 文件夹并编辑 index.html。
8. 指定刚才在上面下载的 JSON/YAML 文件。
9. 通过运行 index.html 来检查它

希望对你有帮助

谢谢。