「Django REST Framework 框架」Status Codes状态响应解析及应用举例

野性酷女 2023-01-10 03:39 169阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Status Codes 状态码
 *  应用举例

# 内容介绍 #

开发环境为 Python3.6，Django 版本 3.0.x ，REST Framework 版本 3.12.x

全部内容索引目录  
**[看懂Django框架，没有最好只有更好][Django]**  
![在这里插入图片描述][20210120153326265.png]  
代码内容基于「Django REST Framework API框架」源码版本 3.12.x ，更新内容会进行标记说明对应版本。

使用框架自带的状态码能更清晰的表达这个请求的相应内容以及错误信息，进行相应的处理。

# Status Codes 状态码 #

from rest_framework import status

**1. Informational - 1xx**

# 此类状态码表示临时的信息状态，在框架中是没有使用这类状态码的。
    HTTP_100_CONTINUE
    HTTP_101_SWITCHING_PROTOCOLS

**2. 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
    HTTP_208_ALREADY_REPORTED
    HTTP_226_IM_USED

**3. 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
    HTTP_308_PERMANENT_REDIRECT

**4. Client Error - 4xx**

# 这类状态码表示客户端出现错误。
    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_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

**5. Server Error - 5xx**

# 这类状态码表示服务端出现错误。
    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

# 应用举例 #

**1.辅助函数**

is_informational()      # 1xx 返回是否 1 开头状态码的布尔值
    is_success()            # 2xx 返回是否 2 开头状态码的布尔值
    is_redirect()           # 3xx 返回是否 3 开头状态码的布尔值
    is_client_error()       # 4xx 返回是否 4 开头状态码的布尔值
    is_server_error()       # 5xx 返回是否 5 开头状态码的布尔值

**2.举例说明**

from rest_framework import status
    status.is_success(200)  # 返回 True
    status.is_success(300)  # 返回 False

[Django]: https://blog.csdn.net/qq_20288327/article/details/117383454
[20210120153326265.png]: /images/20221119/7412a360a1ad4ffca2d92a07dc455f9c.png