【Django restframework】两种接口安全机制及其配置_djangorestframework的token

Django DRF 两种接口安全机制及其配置

接口安全机制，用于设置和管理用户调用接口时的权限问题。此处介绍最常用的两种接口安全机制及其配置。

---

---

---

1 先生成接口文档 便于测试

1.1 安装依赖

pip install coreapi
1

1.2 设置接口文档

在项目配置目录下的urls.py中添加以下代码:

from rest_framework.documentation import include_docs_urls

path('docs/', include_docs_urls(title="测试项目接口文档"))  #路径和title可自定义
1
2
3

在项目配置目录下的全局配置文件settings.py中添加以下代码:

REST_FRAMEWORK = {
   	...
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}
1
2
3
4

---

2 DRF安全机制之Token配置

在项目配置目录下的全局配置文件settings.py中添加以下代码:

INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework.authtoken',
]

REST_FRAMEWORK = {
	...,
    # 配置DRF Token
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.TokenAuthentication',  # Token 认证
    )
}
1
2
3
4
5
6
7
8
9
10
11
12
13

路由配置:在项目配置目录下的urls.py中添加以下代码:

...
from rest_framework.authtoken.views import obtain_auth_token

urlpatterns = [
    ...,
    path('docs/', include_docs_urls(title="测试项目接口文档")),
    # path('api-token-auth/', obtain_auth_token),  # Auth Token
]
1
2
3
4
5
6
7
8

---

3 DRF安全机制之JWT配置

前后端分离项目通常会使用JWT

3.1 安装依赖

pip install djangorestframework-jwt
1

3.2 配置JWT

将认证方式指定为JWTToken认证，并且配置Token的格式、过期时间等属性。

在项目配置目录下的全局配置文件settings.py中添加以下代码:

INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework.authtoken',
]

REST_FRAMEWORK = {
	...,
    # 配置DRF Token
    'DEFAULT_AUTHENTICATION_CLASSES': (
    #    'rest_framework.authentication.TokenAuthentication',  # Token 认证
        'rest_framework_jwt.authentication.JSONWebTokenAuthentication',  # JWT认证
    ),
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
    
    # 配置JWT
    'JWT_EXPIRATION_DELTA': datetime.timedelta(days=3),  # 过期时间 
    'JWT_AUTH_HEADER_PREFIX': 'JWT',  # 设置Token头为 JWT xxxx
    'JWT_ALLOW_REFRESH': False,
    # 'JWT_RESPONSE_PAYLOAD_HANDLER': 'app8.jwt_utils.jwt_response_payload_handler'  # 自定义认证消息
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

在项目配置目录下的urls.py中添加以下代码:

from rest_framework_jwt.views import obtain_jwt_token

urlpatterns = [
    ...,
    path('docs/', include_docs_urls(title="测试项目接口文档")),
    # path('api-token-auth/', obtain_auth_token),  # Auth Token
    path('api-jwt-token-auth/', obtain_jwt_token),  # JWT Token
]
1
2
3
4
5
6
7
8

---

4 使用方式

• Token/JWT格式: Token/JWT + 两个空格 + 具体的Token
• 在Postman请求头headers中添加Authorization及上述Token值。

---