Swagger デコレーター

Swaggerデコレーター

よく使うものの説明

参考:GitHub

頻出デコレーター

@ApiTags()

説明

APIエンドポイントが属するタグを指定します。Swagger UIでの整理に役立つ。

使用例

@ApiTags('users')

---

@ApiOperation()

説明

エンドポイントの操作の概要や説明。APIドキュメントに表示される。

使用例

@ApiOperation({ summary: 'Get user by ID' })

---

@ApiResponse()

説明

エンドポイントのレスポンスについての詳細を指定する。HTTPステータスコードやレスポンスの型を定義する。

使用例

@ApiResponse({ status: 200, description: 'User found', type: User })

---

@ApiParam()

説明

エンドポイントのパラメータに関する情報を提供する。URLパラメータの説明などに使用する。

使用例

@ApiParam({ name: 'id', required: true, description: 'User ID' })

---

@ApiQuery()

説明

クエリパラメータに関する情報を提供する。オプションのクエリパラメータなどに使用できる。

使用例

@ApiQuery({ name: 'limit', required: false, description: 'Number of users to return' })

---

@ApiBody()

説明

リクエストボディの詳細を指定する。特にPOSTやPUTリクエストで使用する。

使用例

@ApiBody({ type: CreateUserDto })

---

@ApiBearerAuth()

説明

Bearerトークンによる認証を使用すること示す。Swagger UIに認証が必要であることを表示する。

使用例

@ApiBearerAuth()