OAS 2 このページは、OpenAPI Specification ver. 2 (旧Swagger)に適用されます。最新バージョンについては、OpenAPI 3のページをご覧ください。

タグを使用した操作のグループ化

各API操作に`tags`のリストを割り当てることができます。タグ付けされた操作は、ツールやライブラリによって異なる方法で処理される場合があります。たとえば、Swagger UIは`tags`を使用して、表示される操作をグループ化します。

paths:
  /pet/findByStatus:
    get:
      summary: Finds pets by Status
      tags:
        - pets
      ...
  /pet:
    post:
      summary: Adds a new pet to the store
      tags:
        - pets
      ...
  /store/inventory:
    get:
      summary: Returns pet inventories
      tags:
        - store
      ...

オプションで、ルートレベルのグローバル`tags`セクションを使用して、各タグに`description`と`externalDocs`を指定できます。ここでのタグ名は、操作で使用されているタグ名と一致する必要があります。

tags:
  - name: pets
    description: Everything about your Pets
    externalDocs:
      url: http://docs.my-api.com/pet-operations.htm
  - name: store
    description: Access to Petstore orders
    externalDocs:
      url: http://docs.my-api.com/store-orders.htm

グローバルタグセクションのタグ順は、Swagger UIのデフォルトのソート順も制御します。ルートレベルで定義されていない場合でも、操作でタグを使用できることに注意してください。

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