タグによる操作のグループ化

各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
      ...

OpenAPI tags in 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でのデフォルトの並べ替えも制御します。ルートレベルで定義されていないタグでも、オペレーションで使用することは可能です。

お探しのものが見つかりませんでしたか？コミュニティに質問する
間違いを見つけましたか？お知らせください