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

本文链接：https://blog.youkuaiyun.com/gitblog_00708/article/details/148360548

Django REST Framework 测试指南：从入门到精通

django-rest-framework encode/django-rest-framework: Django REST framework 是一个强大的 Web API 开发工具包，专为 Django 框架设计，提供了一套丰富的功能集来构建 Web API，包括序列化、分页、权限管理等。项目地址: https://gitcode.com/gh_mirrors/dj/django-rest-framework

前言

在开发 RESTful API 时，编写高质量的测试用例是保证代码质量的关键。Django REST Framework (DRF) 提供了一系列强大的测试工具，可以帮助开发者轻松构建全面的测试套件。本文将深入探讨 DRF 的测试框架，帮助您掌握 API 测试的核心技巧。

测试工具概览

DRF 主要提供了以下几种测试工具类：

APIRequestFactory：用于生成请求对象
APIClient：功能完善的测试客户端
RequestsClient：基于 requests 库的高级客户端
CoreAPIClient：支持 CoreAPI 规范的客户端

APIRequestFactory 详解

APIRequestFactory 是 DRF 对 Django 标准 RequestFactory 的扩展，专门用于 API 测试场景。

基本使用方法

from rest_framework.test import APIRequestFactory

# 创建工厂实例
factory = APIRequestFactory()

# 生成 POST 请求
request = factory.post('/articles/', {'title': '测试文章'})

格式支持

APIRequestFactory 支持通过 format 参数指定请求格式：

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

# 自定义内容类型
request = factory.post('/articles/', yaml.dump(data), content_type='application/yaml')

认证处理

可以直接为请求强制添加认证信息：

from rest_framework.test import force_authenticate

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

重要提示：直接设置 request.user 仅在使用 SessionAuthentication 时有效。

APIClient 全面解析

APIClient 是 DRF 对 Django 测试客户端的扩展，提供了更便捷的 API 测试方式。

基本请求

from rest_framework.test import APIClient

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

认证方式

APIClient 支持多种认证方式：

会话认证（模拟用户登录）

client.login(username='testuser', password='password')
client.logout()

凭证认证（设置请求头）

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

强制认证（绕过认证流程）

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

高级测试场景

1. 测试用例类

DRF 提供了一系列测试用例基类：

from rest_framework.test import APITestCase

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, 201)

2. 隔离 URL 配置

使用 URLPatternsTestCase 可以隔离 URL 配置：

class ArticleTests(APITestCase, URLPatternsTestCase):
    urlpatterns = [
        path('api/', include('articles.urls')),
    ]
    
    def test_article_list(self):
        response = self.client.get('/api/articles/')
        self.assertEqual(response.status_code, 200)

3. 响应测试技巧

直接检查响应数据而非内容：

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

配置选项

默认请求格式

在 settings.py 中配置默认测试请求格式：

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'
    ]
}