我有一个项目托管在GitHub上。为了记录API,我使用的是OpenAPI规范。现在我想在readme.md
(GitHub上(上添加一个链接,该链接将我的访问者引向OpenAPI文档以获得良好的用户体验。
据我所知,我有两个解决方案:
- http://editor.swagger.io/?raw=https://raw.githubusercontent.com/path/to/file.yaml
- https://app.swaggerhub.com/apis/(用户名(/(API 名称(/(API 版本(
这两种方法都有效,但它们都打开左侧的编辑器,该编辑器显示 YAML 文件的内容,恕我直言,浪费了大量的屏幕空间。不是我真正想要的。是否有选项可以在不打开编辑器的情况下显示 OpenAPI 文档?就像在没有编辑器打开的情况下为 https://petstore.swagger.io/所做的类似。
或。。。是否有一个选项可以直接在 GitHub 上显示 OpenAPI 文档?
谢谢,克里斯托夫
如果您使用 SwaggerHub,请将 URL 中的/apis/
替换为/apis-docs/
,以仅查看 API 文档而不查看编辑器部分。例如:
https://app.swaggerhub.com/apis-docs/swagger-hub/registry-api/1.0.47
或者,如果您的 OpenAPI 定义托管在其他地方(例如在 GitHub 上(,您可以使用
https://petstore.swagger.io/?url=https://path/to/file.yaml
以将其加载到公共 Swagger UI 演示中。Swagger UI 在没有编辑器部分的情况下呈现 API 文档。