openapi - 是否可以在 OpenAPI 3 中引用单个路径和方法？

Question

假设我有一个描述 API Foo 的 OpenAPI 3 文档，如下所示:

openapi: 3.0.0
info:
  version: '1'
  title: Foo
paths:
 /foo:
  get:
    responses:
      200:
        description: A Foo
  post:
    responses:
      201:
        description: Foo created

在 API Bar 的另一个 OpenAPI 文档中，我想引用仅来自 API Foo< 的 GET/foo 操作。 OpenAPI 文档 talk a little about referencing a whole path .但是，如果我执行以下操作:

openapi: 3.0.0
info:
  version: '1'
  title: Bar
paths:
 /foo:
  $ref: 'foo.yaml#/paths/~1foo'

我很自然地在 API Bar 中同时获得了 GET 和 POST，因为只引用了路径，没有引用方法。

我试过这个:

openapi: 3.0.0
info:
  version: '1'
  title: Bar
paths:
 /foo:
   get:
     $ref: 'foo.yaml#/paths/~1foo/get'

但这会产生错误，例如 should NOT have additional properties additionalProperty: $ref 和 should have required property 'responses' missingProperty: responses 在各种工具中，所以它不会'似乎不支持。

有没有办法做到这一点？我应该注意到真正的请求要复杂得多，因此需要去重。如果可能的话，我想避免用单独的 $ref 填充 get 的许多子对象。

Answer 1

OpenAPI 没有办法$ref 一个单独的操作(get/post/等等)，你只能$ref 一个完整的路径。

您可以在 OpenAPI 规范存储库中提出语法增强:
https://github.com/OAI/OpenAPI-Specification/issues