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

如何解决带有我自己的 yaml 文件的 swagger API 文档

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

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

有什么想法吗？

解决方法

如果由于某种原因您无法自己托管 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。