yaml - 使用 $ref 将 Openapi YAML 配置部署到 Google Endpoint

Question

如果 Openapi YAML 配置从多个文件引用并将文件存储在文件夹结构中，是否可以将其部署到 Google Endpoints？

例如：

-\ openapi.yaml
--\service1\service1.yaml
--\service2\service2.yaml
.
.
.

假设 openapi.yaml 对 service1.yaml 和 service2.yaml 中的一个或多个定义有 $ref。

请注意，我有大量的文件夹和 YAML，以上只是我想要实现的一个示例。

如何使用服务管理将此结构按原样部署到 Google Endpoints？

Answer 1

不幸的是，Endpoints 对 OpenAPI 的支持不处理外部类型引用。即使这样做了，在 OpenAPI 上传期间也不会保留路径结构gcloud endpoints services deploy。

Answer 2

作为一种解决方法，您可以使用speccy来完成此任务。它将您的 api 描述与您的所有引用合并到单个可部署的 yaml 文件中。 speccy resolve openapi-template.yaml -j -o openapi.yaml 您甚至可以通过添加-j标志将 json 引用合并到您的 yaml 文件中。

Speccy 是一个 npm 包，因此，您显然需要一个 node.js 环境来使用它。