Swaggerでの「collapse all」の使用方法

「collapse all」は、SwaggerのUI上で表示されるドキュメントのセクションを折りたたむ機能です。これにより、大きなAPI仕様書をシンプルに表示することができます。以下に、Swaggerで「collapse all」を使用する方法とコード例を示します。

Swagger UIの設定ファイルで「collapse」オプションを有効にする方法:

Swagger UIの設定ファイル（通常はswagger-ui.htmlまたはindex.html）を開きます。次に、以下のように「collapse」オプションを有効にします。

const ui = SwaggerUIBundle({
  // ...他の設定オプション
  docExpansion: "none",
  defaultModelsExpandDepth: -1,
  operationsSorter: "alpha",
  // "collapse"オプションを有効にする
  tagsSorter: "alpha",
  // ...他の設定オプション
})

エンドポイントごとに「collapse」オプションを使用する方法:

SwaggerのAPI定義ファイル（通常はswagger.yamlまたはswagger.json）を開きます。各エンドポイントの定義に対して、以下のように「collapse」オプションを追加します。

paths:
  /users:
    get:
      summary: ユーザー情報を取得する
      description: |
        このAPIはユーザーの情報を取得するためのものです。
      tags:
        - users
      collapse: true  # エンドポイントを折りたたむ
      responses:
        200:
          description: 成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'

これで、「collapse all」機能が有効になり、Swagger UI上でエンドポイントが折りたたまれた状態で表示されます。

以上がSwaggerで「collapse all」機能を使用する方法とコード例です。この機能を使用することで、大規模なAPIドキュメントを整理し、読みやすくすることができます。エラー処理や他の関連する機能についても、Swaggerの公式ドキュメントやコミュニティのリソースを参考にしてください。