如何将 $ref 用于文件之间的标签答案

【问题标题】：How to use $ref for tags between files如何将 $ref 用于文件之间的标签
【发布时间】：2020-03-21 19:08:19
【问题描述】：

我正在使用 Open API 3.0，在 A.yaml

# something above

tags:
  - name: user
    description: Operations about user
  - name: user_stuff
    description: API for user stuff
  - name: another_user_stuff
    description: API for another user stuff

# something below

那么，在B.yaml中，我想引用A.yaml中的标签，例如user的标签。假设在B.yaml，我们有

post:
  tags:
    $ref: <What are the things should be here?>
  summary: do somthing
  description: "do something"
  requestBody:
    # bla bla bla
    required: true
  responses:
    "200":
      description: uccessfully
  x-swagger-router-controller: B

如何将B.yaml 引用到A.yaml？

【问题讨论】：

标签： yaml swagger openapi

【解决方案1】：

tags 关键字不支持$ref。所有标签都必须内联定义。

# B.yaml
tags:
  - name: foo
    description: Operations to manage Foos.

paths:
  /something:
    post:
      tags:
        - foo
        - bar

也就是说，您不必在全局 tags 部分中定义标签即可在操作中使用它们。全局tags 部分仅用于定义额外的标记元数据，例如描述和externalDocs，或文档工具中的标记顺序。

【讨论】：