如何使用$ ref引用另一个OpenAPI文件的路径?

时间:2019-11-18 06:36:45

标签: openapi

Here它说我可以为另一个路径引用另一个文件中的定义,但是该示例似乎引用了整个文件,而不是paths对象下的单个路径定义。如何在另一个文件的paths对象中分配一个单独的路径?

例如,我有Anotherfile.yaml,其中包含/a/b路径:

paths:
  /a/b:
    post:

在另一个文件中,我使用$ref来引用/a/b路径,如下所示:

paths:
  /c/d:
    $ref: 'Anotherfile.yaml#/paths/a/b'

但这会导致错误:

  

在./Anotherfile.yaml的内容中找不到路径/ a / b

1 个答案:

答案 0 :(得分:1)

在引用路径时,您需要通过将/替换为~1escape the path name,以使/a/b成为~1a~1b。请注意,您仅转义了路径名,而不是#/paths/前缀。

$ref: 'Anotherfile.yaml#/paths/~1a~1b'