Django REST Framework 测试指南：从入门到实践-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01061/article/details/148360327

Django REST Framework 测试指南：从入门到实践

django-rest-framework 项目地址: https://gitcode.com/gh_mirrors/dja/django-rest-framework

前言

在开发 RESTful API 时，编写高质量的测试用例是确保代码健壮性的关键。Django REST Framework 提供了一系列强大的测试工具，帮助开发者更高效地编写 API 测试。本文将深入探讨这些测试工具的使用方法和最佳实践。

测试工具概览

Django REST Framework 主要提供了三类测试客户端：

APIRequestFactory：用于生成请求对象
APIClient：功能完整的测试客户端
RequestsClient：基于 requests 库的高级客户端

APIRequestFactory 详解

APIRequestFactory 是 Django RequestFactory 的扩展，专门为 REST 框架设计。

基本用法

from rest_framework.test import APIRequestFactory

factory = APIRequestFactory()
request = factory.post('/articles/', {'title': '测试文章'})

支持的数据格式

默认支持 multipart 和 json 两种格式：

# JSON 格式请求
request = factory.post('/articles/', {'title': '测试文章'}, format='json')

强制认证

可以直接为请求设置认证用户：

from rest_framework.test import force_authenticate

user = User.objects.get(username='testuser')
request = factory.get('/private/')
force_authenticate(request, user=user)

注意事项

返回的是 Django 的 HttpRequest 而非 REST 框架的 Request
直接设置 request.user 仅在使用 SessionAuthentication 时有效
默认不启用 CSRF 检查，可通过 enforce_csrf_checks=True 启用

APIClient 全面指南

APIClient 是 Django 标准 Client 的扩展，提供了更丰富的 API 测试功能。

基本请求

from rest_framework.test import APIClient

client = APIClient()
response = client.post('/articles/', {'title': '测试文章'}, format='json')

认证方式

1. 会话认证

client.login(username='testuser', password='password')
# 测试代码...
client.logout()

2. 凭证认证

from rest_framework.authtoken.models import Token

token = Token.objects.get(user__username='testuser')
client.credentials(HTTP_AUTHORIZATION='Token ' + token.key)

3. 强制认证

user = User.objects.get(username='testuser')
client.force_authenticate(user=user)

CSRF 处理

默认禁用 CSRF 检查，可通过以下方式启用：

client = APIClient(enforce_csrf_checks=True)

RequestsClient 高级用法

RequestsClient 允许使用 Python requests 库进行测试，适合以下场景：

测试从其他 Python 服务调用的 API
编写可在不同环境运行的测试用例

基本示例

from rest_framework.test import RequestsClient

client = RequestsClient()
response = client.get('http://testserver/articles/')
assert response.status_code == 200

CSRF 处理

# 获取 CSRF token
response = client.get('http://testserver/homepage/')
csrftoken = response.cookies['csrftoken']

# 使用 CSRF token 发送请求
response = client.post('http://testserver/articles/', 
    json={'title': '测试文章'},
    headers={'X-CSRFToken': csrftoken})

测试用例类

Django REST Framework 提供了一系列测试用例基类：

APISimpleTestCase
APITransactionTestCase
APITestCase
APILiveServerTestCase

示例测试用例

from rest_framework.test import APITestCase
from rest_framework import status

class ArticleTests(APITestCase):
    def test_create_article(self):
        url = '/articles/'
        data = {'title': '测试文章'}
        response = self.client.post(url, data, format='json')
        self.assertEqual(response.status_code, status.HTTP_201_CREATED)

测试响应检查

检查响应数据

response = self.client.get('/users/1/')
self.assertEqual(response.data, {'id': 1, 'username': 'testuser'})

渲染响应

使用 APIRequestFactory 时，需要手动渲染响应：

view = UserDetail.as_view()
request = factory.get('/users/1')
response = view(request, pk='1')
response.render()  # 必须调用才能访问 response.content
self.assertEqual(response.content, '{"username": "testuser", "id": 1}')

配置选项

设置默认格式

REST_FRAMEWORK = {
    'TEST_REQUEST_DEFAULT_FORMAT': 'json'
}

添加其他格式支持

REST_FRAMEWORK = {
    'TEST_REQUEST_RENDERER_CLASSES': [
        'rest_framework.renderers.MultiPartRenderer',
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.TemplateHTMLRenderer'
    ]
}