1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

@nestjs/swagger Responseの種類

Posted at

@nestjs/swaggerのResponseは様々な種類があるが、http statusがどれかいちいち調べるのがめんどくさかったのでまとめた。

| code | function | description |
|:-----------|:------------|:------------|:------------|
|200|ApiOkResponse|リクエストが成功したことを示します。|
|201|ApiCreatedResponse|リクエストは成功し、その結果新たなリソースが作成されたことを示します。|
|202|ApiAcceptedResponse|リクエストは受理されたが、まだ実行されていないことを示します。|
|204|ApiNoContentResponse|リクエストに対して送信するコンテンツはありませんが、ヘッダーは有用であることを示します。|
|301|ApiMovedPermanentlyResponse|リクエストされたリソースの URL が永遠に変更されたことを示します。|
|400|ApiBadRequestResponse|構文が無効であるためサーバーがリクエストを理解できないことを示します。|
|401|ApiUnauthorizedResponse|HTTP 標準では "unauthorized" (不許可) と定義されていますが、意味的にはこのレスポンスは "unauthenticated" (未認証) です。つまり、クライアントはリクエストされたレスポンスを得るためには認証を受けなければなりません。|
|403|ApiForbiddenResponse|認証されていないなどの理由でクライアントにコンテンツのアクセス権がなく、サーバーが適切なレスポンスの返信を拒否していることを示します。|
|404|ApiNotFoundResponse|サーバーがリクエストされたリソースを発見できないことを示します。|
|405|ApiMethodNotAllowedResponse|サーバーがリクエストメソッドを理解しているものの、無効にされており使用することができません。|
|406|ApiNotAcceptableResponse|このレスポンスは、ウェブサーバーが サーバー駆動型コンテンツネゴシエーション を行った結果、ユーザーエージェントから与えられた条件に合うコンテンツが見つからない場合に送信されます。|
|408|ApiRequestTimeoutResponse|このレスポンスはクライアントが以前にリクエストを行っていない、アイドル状態のコネクションにおいて一部のサーバーが送信します。サーバーは使用していないコネクションの終了を望むことを示します。|
|409|ApiConflictResponse|このレスポンスは、リクエストがサーバーの現在の状態と矛盾する場合に送られるでしょう。|
|410|ApiGoneResponse|このレスポンスは、リクエストされたコンテンツがサーバーから永久に削除され、転送先アドレスがない場合に送られます。|
|413|ApiPayloadTooLargeResponse|リクエストの本体がサーバーで定めている上限を超えていることを示します。|
|415|ApiUnsupportedMediaTypeResponse|リクエストされたデータのメディア形式をサーバーが対応しておらず、サーバーはリクエストを拒否したことを示します。|
|422|ApiUnprocessableEntityResponse|リクエストは適正ですが、意味が誤っているために従うことができません。|
|429|ApiTooManyRequestsResponse|ユーザーは一定の時間内に大量のリクエストを送信しました ("レート制限")。|
|500|ApiInternalServerErrorResponse|サーバー側で処理方法がわからない事態が発生したことを示します。|
|501|ApiNotImplementedResponse|リクエストメソッドをサーバーが対応しておらず、扱えないことを示します。|
|502|ApiBadGatewayResponse|このエラーレスポンスは、リクエストの処理に必要なレスポンスを受け取るゲートウェイとして動作するサーバーが無効なレスポンスを受け取ったことを示します。|
|503|ApiServiceUnavailableResponse|サーバーはリクエストを処理する準備ができていないことを示します。|
|504|ApiGatewayTimeoutResponse|このエラーレスポンスは、ゲートウェイとして動作するサーバーが時間内にレスポンスを得られない場合に送られます。|
|default|ApiDefaultResponse||

statusコードの詳細は以下を参照
https://developer.mozilla.org/ja/docs/Web/HTTP/Status

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?