使用标签对操作进行分组

您可以为每个 API 操作分配一个 tags 列表。带有标签的操作可能会被工具和库以不同的方式处理。例如，Swagger UI 使用 tags 对显示的操作进行分组。

1
paths:
2
  /pet/findByStatus:
3
    get:
4
      summary: Finds pets by Status
5
      tags:
6
        - pets
7
      ...
8
  /pet:
9
    post:
10
      summary: Adds a new pet to the store
11
      tags:
12
        - pets
13
      ...
14
  /store/inventory:
15
    get:
16
      summary: Returns pet inventories
17
      tags:
18
        - store
19
      ...

Swagger UI 中的标签您可以选择使用根级别的全局 tags 部分为每个标签指定 description 和 externalDocs。此处的标签名称应与操作中使用的标签名称匹配。

1
tags:
2
  - name: pets
3
    description: Everything about your Pets
4
    externalDocs:
5
      url: http://docs.my-api.com/pet-operations.htm
6
  - name: store
7
    description: Access to Petstore orders
8
    externalDocs:
9
      url: http://docs.my-api.com/store-orders.htm

全局标签部分中的标签顺序还控制 Swagger UI 中的默认排序。请注意，即使未在根级别定义标签，也可以在操作中使用标签。

OpenAPI tags in Swagger UI

没有找到您要查找的内容？向社区提问
发现错误？请告知我们