带有我自己的 yaml 文件的 swagger API 文档

Question

我用 Swagger 记录了我的 API。为了方便开发人员，我也想在我的网站上提供招摇的 GUI。但是，我的提供商没有安装 php yaml 扩展。这意味着我无法在自己的网站上使用 GUI。

所以，我想使用第三方 GUI。我知道我可以使用https://petstore.swagger.io/ 并在文本框中输入指向我的yaml 文件的链接。这也不是真正的用户友好。我更喜欢在调用 url 时打开 GUI 并指定 yaml。对于用户，GUI 会打开我的 API 定义。

有什么想法吗？

Answer 1

如果由于某种原因您无法自己托管 Swagger UI，您可以尝试以下替代方案：

• 使用SwaggerHub 来托管您的 API 定义和文档。
  披露：我为制作 SwaggerHub 的公司工作。

• 使用 GitLab 来托管您的 OpenAPI YAML/JSON 文件。 GitLab uses Swagger UI 渲染 OpenAPI 文件。示例：
  https://gitlab.com/gofus/gofus-api/blob/dev/swagger.yaml

• 使用https://petstore.swagger.io 和url 查询参数来自动加载您的API 定义：

  https://petstore.swagger.io?url=https://yoursite.com/api.yaml
  

  为此，托管 OpenAPI 文件的服务器必须使用 HTTPS 和 support CORS。