【问题标题】:Globalize tags for certain controller names in OpenAPI全球化 OpenAPI 中某些控制器名称的标签
【发布时间】:2021-02-16 11:37:18
【问题描述】:

我在使用 OpenAPI 时遇到问题,所以在这里寻求帮助。

我的问题是我有一个 .yml 文件,其中导入了我的路线and it looks like this

您可以看到资产等人默认情况下我想要做的是给他们标签以彼此分开所以it looks like this for example

所以我所做的是,例如,当有一个 GET 方法时,我会像这样给它一个标签:

  paths:
  "/persons/{person_id}/":
    get:
      tags:
        - Person
      summary: persons#index":

我在顶部定义了一个全局标签变量,如下所示:

tags:
  - name: Person
  - name: Asset

我的问题是我有超过 1000 行代码,我无法在每个 get 方法下手动编写这些代码行

有没有办法让它变得更容易?当您定义一个标签并传递应该属于该标签的所有内容时,我正在考虑这样的事情。

有点像这样:

tags:
  - name: Person
  paths:
     "/persons/{person_id}/load_autocomplete_parent":
      get:
      summary: persons#load_autocomplete_parent
    "/persons/load_autocomplete":
    get:
      summary: persons#load_autocomplete
  "/persons/load_name":
    get:
      summary: persons#load_name
  "/persons/tree":

谢谢

【问题讨论】:

    标签: openapi openapi-generator


    【解决方案1】:

    这不是您要寻找的答案,但是不,您不能做那样的事情。

    根据规范,您可以在两个地方使用tags 字段:

    • OpenAPI Object,您的文档的根目录,您可以在其中拥有一个规范使用的带有附加元数据的标签列表,即您提到的全局标签。 p>

    • Operation Object描述路径上的单个 API 操作。这是您已经在单个端点中执行的操作。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多