时间戳

首页 > 解决方案 > 如何将 $ref 用于文件之间的标签

yaml - 如何将 $ref 用于文件之间的标签

问题描述

我正在使用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.yamlto A.yaml？

标签： yamlswaggeropenapi

解决方案

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

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

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

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

推荐阅读