Django Rest Framework (DRF) 介绍与快速入门 – wiki大全

作者： /

I apologize. I’ve misunderstood the available tools again. My tools are list_directory, read_file, search_file_content, glob, activate_skill, save_memory, and write_todos. I cannot directly write files. I will provide the content of the article as my response.

Django Rest Framework (DRF) 介绍与快速入门

什么是 Django Rest Framework (DRF)？

Django Rest Framework (DRF) 是一个强大且灵活的工具包，用于在 Django 的基础上构建 Web API。它极大地简化了 API 的开发过程，提供了丰富的功能集，包括序列化、认证、权限、限流、视图集和路由器等，使得开发者能够快速地构建出健壮、可维护的 RESTful API。

为什么选择 DRF？

  1. 快速开发: DRF 提供了许多开箱即用的组件，如 ModelSerializer、ViewSets 和 Routers，可以大大减少编写样板代码的时间，加速 API 的开发。
  2. 强大的序列化: 轻松地将 Django 模型实例或其他数据类型转换为 JSON、XML 等 Web 可接受的表示形式，反之亦然。它支持复杂的数据结构，包括嵌套关系和自定义字段。
  3. 灵活的认证和权限: 内置多种认证（如 Token 认证、Session 认证、OAuth2 等）和权限策略，可以轻松控制 API 的访问。
  4. 可浏览的 API: DRF 提供了一个优秀的、人性化的可浏览 API 界面。这使得开发者和团队成员可以方便地在浏览器中测试和与 API 交互，极大地提高了开发效率和调试体验。
  5. 丰富的文档和社区支持: 作为一个广泛使用的框架，DRF 拥有详尽的官方文档和活跃的社区，遇到问题时很容易找到解决方案。
  6. 与 Django 完美集成: 由于它建立在 Django 之上，因此可以充分利用 Django ORM、Admin 界面以及其强大的生态系统。

核心组件与概念

  • Serializer (序列化器): 负责将复杂数据类型（如 Django 模型实例、QuerySet）转换为原生 Python 数据类型（字典、列表），进而可以轻松地渲染为 JSON、XML 或其他内容类型。反之，它也可以将原生数据类型转换回复杂数据类型，进行数据验证和保存。ModelSerializer 可以自动从 Django 模型中生成序列化器字段。
  • View (视图): 处理传入的 HTTP 请求，并返回 HTTP 响应。DRF 提供了多种视图类型，从简单的 APIView 到功能更丰富的 GenericAPIView 和 ModelViewSet。
  • ViewSet (视图集): 将一组相关的视图逻辑（如 list, retrieve, create, update, destroy）组合在一个类中。它与路由器 (Routers) 结合使用时，可以自动生成 URL 配置，极大地简化了 URL 路由的设置。
  • Router (路由器): 自动为 ViewSet 生成 URL 配置。DefaultRouter 和 SimpleRouter 是最常用的路由器。
  • Renderer (渲染器): 决定 API 返回响应的格式（如 JSON、HTML）。
  • Parser (解析器): 决定 API 接受请求数据的格式（如 JSON、表单数据）。
  • Authentication (认证): 识别用户的身份。
  • Permissions (权限): 决定用户是否有权执行某个操作。
  • Throttling (限流): 控制客户端在给定时间内可以向 API 发出请求的频率。

快速入门

1. 安装 DRF

首先，确保你已经安装了 Django。然后，安装 Django Rest Framework：

bash
pip install djangorestframework

2. 配置 Django 项目

将 rest_framework 添加到你的 Django 项目的 settings.py 中的 INSTALLED_APPS：

“`python

your_project/settings.py

INSTALLED_APPS = [
# …
‘rest_framework’,
# …
]
“`

3. 创建一个 Django 应用

如果你还没有应用，创建一个新的 Django 应用：

bash
python manage.py startapp myapi

将 myapi 也添加到 INSTALLED_APPS。

4. 定义模型 (Model)

在 myapi/models.py 中定义一个简单的模型：

“`python

myapi/models.py

from django.db import models

class Product(models.Model):
name = models.CharField(max_length=100)
description = models.TextField()
price = models.DecimalField(max_digits=10, decimal_places=2)
created_at = models.DateTimeField(auto_now_add=True)

def __str__(self):
    return self.name

“`

运行迁移以创建数据库表：

bash
python manage.py makemigrations
python manage.py migrate

5. 创建序列化器 (Serializer)

在 myapi/serializers.py 中创建一个序列化器，将 Product 模型转换为 JSON：

“`python

myapi/serializers.py

from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
class Meta:
model = Product
fields = [‘id’, ‘name’, ‘description’, ‘price’, ‘created_at’]
“`

ModelSerializer 是 DRF 提供的一个便捷类，它会自动为你生成与模型字段对应的序列化器字段。

6. 创建视图集 (ViewSet)

在 myapi/views.py 中创建一个视图集来处理 Product 模型的 CRUD 操作：

“`python

myapi/views.py

from rest_framework import viewsets
from .models import Product
from .serializers import ProductSerializer

class ProductViewSet(viewsets.ModelViewSet):
queryset = Product.objects.all()
serializer_class = ProductSerializer
“`

ModelViewSet 提供了 list, retrieve, create, update, partial_update, destroy 等操作的实现。

7. 配置 URL 路由

在 myapi/urls.py 中配置路由：

“`python

myapi/urls.py

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import ProductViewSet

router = DefaultRouter()
router.register(r’products’, ProductViewSet)

urlpatterns = [
path(”, include(router.urls)),
]
“`

然后在你的项目的主 urls.py 中包含 myapi 的 URL：

“`python

your_project/urls.py

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
path(‘admin/’, admin.site.urls),
path(‘api/’, include(‘myapi.urls’)), # 将 DRF 的 API 包含进来
]
“`

8. 运行开发服务器并测试

运行 Django 开发服务器：

bash
python manage.py runserver

现在，你可以访问 http://127.0.0.1:8000/api/products/。你将看到 DRF 的可浏览 API 界面，允许你查看、添加、编辑和删除产品。

你可以尝试使用浏览器访问这些 URL：

  • http://127.0.0.1:8000/api/products/ (GET 请求获取所有产品，POST 请求创建新产品)
  • http://127.0.0.1:8000/api/products/1/ (GET 请求获取 ID 为 1 的产品，PUT/PATCH 更新，DELETE 删除)

总结

Django Rest Framework 提供了一种高效、优雅的方式来构建 Web API。通过序列化器、视图集和路由器的配合，开发者可以大大简化 API 的开发流程，同时享受到 DRF 提供的强大功能和出色的可浏览 API 界面。希望这篇介绍能帮助你快速入门 DRF，并开始构建自己的 RESTful API！

滚动至顶部