ステータスコード
418 I'm a teapot - ティーポットでコーヒーを淹れようとすると、エラーコード "418 I'm a teapot" が返されるべきです。結果として返されるエンティティボディは、短くずんぐりむっくりなものであるかもしれません。
— RFC 2324, Hyper Text Coffee Pot Control Protocol
レスポンスに生のステータスコードを使用することは推奨されません。REST framework には、コードをより明確で読みやすくするために使用できる名前付き定数のセットが含まれています。
from rest_framework import status
from rest_framework.response import Response
def empty_view(self):
content = {'please move along': 'nothing to see here'}
return Response(content, status=status.HTTP_404_NOT_FOUND)
status モジュールに含まれる HTTP ステータスコードの完全なセットは、以下にリストされています。
モジュールには、ステータスコードが特定の範囲内にあるかどうかをテストするためのヘルパー関数も含まれています。
from rest_framework import status
from rest_framework.test import APITestCase
class ExampleTestCase(APITestCase):
def test_url_root(self):
url = reverse('index')
response = self.client.get(url)
self.assertTrue(status.is_success(response.status_code))
HTTPステータスコードの適切な使用法については、RFC 2616 および RFC 6585 を参照してください。
情報提供 - 1xx
このクラスのステータスコードは、一時的なレスポンスを示します。REST framework ではデフォルトで使用される 1xx ステータスコードはありません。
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
HTTP_102_PROCESSING
HTTP_103_EARLY_HINTS
成功 - 2xx
このクラスのステータスコードは、クライアントのリクエストが正常に受信、理解、および受理されたことを示します。
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
HTTP_208_ALREADY_REPORTED
HTTP_226_IM_USED
リダイレクト - 3xx
このクラスのステータスコードは、リクエストを完了するためにユーザーエージェントがさらにアクションを実行する必要があることを示します。
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
HTTP_308_PERMANENT_REDIRECT
クライアントエラー - 4xx
4xxクラスのステータスコードは、クライアントがエラーを犯したと思われる場合に意図されています。HEADリクエストに応答する場合を除き、サーバーは、エラー状態の説明と、それが一時的な状態であるか永続的な状態であるかを示すエンティティを含めるべきです。
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_421_MISDIRECTED_REQUEST
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_425_TOO_EARLY
HTTP_426_UPGRADE_REQUIRED
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
サーバーエラー - 5xx
数字 "5" で始まるレスポンスステータスコードは、サーバーがエラーを犯したこと、またはリクエストを実行できないことを認識している場合を示します。HEADリクエストに応答する場合を除き、サーバーは、エラー状態の説明と、それが一時的な状態であるか永続的な状態であるかを示すエンティティを含めるべきです。
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_506_VARIANT_ALSO_NEGOTIATES
HTTP_507_INSUFFICIENT_STORAGE
HTTP_508_LOOP_DETECTED
HTTP_509_BANDWIDTH_LIMIT_EXCEEDED
HTTP_510_NOT_EXTENDED
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
ヘルパー関数
レスポンスコードのカテゴリを識別するために、次のヘルパー関数が利用できます。
is_informational() # 1xx
is_success() # 2xx
is_redirect() # 3xx
is_client_error() # 4xx
is_server_error() # 5xx