Status Codes

3085 ワード

Status Codes
応答に個別のステータスコードのみを使用することは推奨されません.RESTフレームワークは、より多くのコードをより明確かつ読み取り可能にするために使用できるネーミング定数のセットを含む.
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)

ステータスモジュールに含まれる完全なHTTPステータスコードを以下に示します.このモジュールには、ステータスコードが所定の範囲内にあるかどうかをテストするhelper関数のセットも含まれています.
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 and RFC 6585を参照してください.
Informational - 1xx
このようなステータスコードは、一時的な応答を表す.デフォルトでは、RESTフレームワークでは1 xxステータスコードは使用されません.
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS

Successful - 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

Redirection - 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

Client Error-4 xx 4 xxクラスのステータスコードは、クライアントにエラーがあるように見える場合に適用されます.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_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS

Server Error - 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_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED

Helper functions
次のヘルプ関数は、レスポンスコードのカテゴリを識別するために使用できます.
is_informational()  # 1xx
is_success()        # 2xx
is_redirect()       # 3xx
is_client_error()   # 4xx
is_server_error()   # 5xx