Django REST framework API 指南（25）：狀態碼

wcode發表於2018-03-24
DjangoRESTFrameworkAPI

官方原文連結
本系列文章 github 地址
轉載請註明出處

狀態碼

不建議在你的響應中使用裸露（直接使用數字）的狀態碼。 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))
複製程式碼

資訊 - 1xx

這類狀態碼錶示臨時響應。預設情況下，REST framework 中沒有使用 1xx 狀態碼。

HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS 
複製程式碼

成功 - 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
複製程式碼

重定向 - 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
複製程式碼

客戶端錯誤 - 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_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
複製程式碼

伺服器錯誤 - 5xx

5xx 表示伺服器意識到其發生錯誤或無法執行請求的情況。除了響應 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
複製程式碼

幫助函式

以下幫助函式可用於識別響應程式碼的類別。

is_informational()  # 1xx
is_success()        # 2xx
is_redirect()       # 3xx
is_client_error()   # 4xx
is_server_error()   # 5xx
複製程式碼

相關文章