全球化 OpenAPI 中某些控制器名称的标签

Globalize tags for certain controller names in OpenAPI

我在使用 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":

谢谢

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

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

  • OpenAPI Object,您文档的根目录,您可以在其中获得规范使用的标签列表以及附加元数据,也就是你提到的全局标签。

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