使用Swagger Editor

Question

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

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

已下载Swagger编辑器，并希望开始记录。 任何特定的指针都会有所帮助。

感谢。

关心， -Nayan Parikh

Answer 1

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

使用Swagger-Editor进行记录

1. 在线打开Swagger编辑器https://editor.swagger.io/         OR
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上查看

1. 从链接https://github.com/swagger-api/swagger-ui
下载swagger-ui
2. 转到dist文件夹并编辑index.html。
3. 指定您刚刚在上面下载的JSON / YAML文件。
4. 通过运行index.html
进行检查

希望这有帮助

感谢。