Python djangorestframework 模块：全面入门

Travis Tang

2024-07-25

Python djangorestframework 模块：全面入门

Django REST framework（简称 DRF）是 Django 框架的一个强大且灵活的工具，用于构建 Web API。这一模块提供了许多可以简化开发过程的功能，使得创建和维护 API 变得更加轻松。它支持多种认证和权限管理方式，能够为开发者提供灵活的响应和数据序列化功能，非常适合于构建现代 Web 应用程序。

模块介绍

Django REST framework 的核心功能包括请求解析、数据验证、序列化以及响应格式化等。它与 Django 紧密集成，支持与常见的数据库如 SQLite、PostgreSQL 等的交互。DRF 需要 Python 3.6 及以上版本。

应用场景

Django REST framework 主要用于构建基于 RESTful 架构的 API，广泛应用于以下场景：

跨平台应用：可支持移动端和网页端调用相同的 API。
微服务架构：API 提供服务之间的通信机制。
数据采集与处理：通过 API 进行数据交互，特别是与第三方服务的数据整合。

安装说明

Django REST framework 不是 Python 的内置标准库，需要单独安装。可以通过 pip 安装：

1	pip install djangorestframework # 安装 Django REST framework 模块

在 Django 项目中的 settings.py 文件里注册 DRF：

INSTALLED_APPS = [
    ...,
    'rest_framework',  # 注册 DRF 模块
]

用法举例

1. 示例一：创建基本的 API 视图

from rest_framework.views import APIView  # 导入 API 视图
from rest_framework.response import Response  # 导入响应对象
from rest_framework import status  # 导入状态码

class HelloWorld(APIView):  # 创建一个 HelloWorld 视图
    def get(self, request):  # 处理 GET 请求
        return Response({"message": "Hello, World!"}, status=status.HTTP_200_OK)  # 返回响应

通过上面的代码，我们创建了一个基本的 API 视图，该视图响应 GET 请求并返回一个简单的 JSON 消息。

2. 示例二：使用序列化器

from rest_framework import serializers  # 导入序列化器模块
from django.contrib.auth.models import User  # 导入用户模型

class UserSerializer(serializers.ModelSerializer):  # 创建用户序列化器
    class Meta:  
        model = User  # 指定模型为 User
        fields = ['id', 'username', 'email']  # 指定需要序列化的字段

# 使用序列化器
user = User.objects.first()  # 获取第一个用户
serializer = UserSerializer(user)  # 实例化序列化器
print(serializer.data)  # 打印序列化后的用户数据

通过这个例子，我们展示了如何使用序列化器将 Django 模型对象转换为可返回的 JSON 数据。

3. 示例三：创建 RESTful 风格的 API

from rest_framework import viewsets  # 导入视图集模块
from .models import Product  # 导入产品模型
from .serializers import ProductSerializer  # 导入产品序列化器

class ProductViewSet(viewsets.ModelViewSet):  # 创建产品视图集
    queryset = Product.objects.all()  # 获取所有产品
    serializer_class = ProductSerializer  # 指定使用的序列化器

此代码展示了如何创建完整的 RESTful API 视图集，它自动处理 CRUD（创建、读取、更新、删除）操作。

感谢您阅读本文，强烈建议大家关注我的博客全糖冲击博客。这是一片知识的海洋，提供了详尽的 Python 标准库使用教程，便于您在学习与工作中的查阅。无论您是新手还是老手，这里都能助您更快地掌握 Python 相关知识，与我一起成长，共同探索更多编程的乐趣！

软件和库版本不断更新

由于软件和库版本不断更新，如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang