python DRF 笔记

Python DRF 笔记

什么是DRF

DRF（Django REST framework）是一个基于Django框架的强大的Web API开发工具包。它提供了一些工具和库，使得构建高性能的、合理的、灵活的Web API变得更加容易。使用DRF，我们可以快速地构建出符合RESTful架构风格的API，并且可以轻松地处理序列化、身份验证、权限控制等问题。它的目标是使得构建Web API的过程变得简单、快捷、高效。

快速开始

首先，我们需要安装DRF包。可以使用pip命令来进行安装：

pip install djangorestframework

安装完成后，我们需要在Django项目的settings文件中添加DRF的配置项。在INSTALLED_APPS列表中添加'rest_framework'：

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

创建序列化器

在DRF中，我们使用序列化器（Serializer）来对模型数据进行序列化和反序列化。序列化器可以将模型实例转换为Python原生数据类型，并且可以进行验证和反序列化。在Django中，模型实例是非常常见的数据形式，使用序列化器可以方便地将这些数据转换为JSON或其他格式。

下面是一个简单的序列化器示例：

from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    title = serializers.CharField(max_length=100)
    author = serializers.CharField(max_length=100)
    price = serializers.DecimalField(max_digits=5, decimal_places=2)

在这个示例中，我们创建了一个BookSerializer类，它继承自DRF中的Serializer类。然后我们定义了一些字段，这些字段将被用于序列化和反序列化。

创建视图

在DRF中，我们使用视图（View）来处理HTTP请求。视图是一个函数或类，接收请求并将其转换为响应。可以通过定义视图类来自定义视图的行为，也可以使用DRF提供的通用视图类来快速构建视图。

下面是一个基于DRF的视图示例：

from rest_framework.views import APIView
from rest_framework.response import Response

class BookAPIView(APIView):
    def get(self, request):
        books = Book.objects.all()
        serializer = BookSerializer(books, many=True)
        return Response(serializer.data)

在这个示例中，我们创建了一个BookAPIView类，它继承自DRF中的APIView类。然后我们定义了一个get方法，用于处理HTTP的GET请求。在这个方法中，我们从数据库中获取所有书籍的数据，并使用上面定义的序列化器将数据序列化为JSON格式。最后，我们返回序列化后的数据作为响应。

配置URL

在Django中，我们通常会在urls.py文件中配置URL路由。在DRF中也是一样的，我们需要配置URL来将请求路由到对应的视图。

下面是一个基于DRF的URL配置示例：

from django.urls import path
from .views import BookAPIView

urlpatterns = [
    path('books/', BookAPIView.as_view()),
]

在这个示例中，我们创建了一个URL路由，将/books/路径映射到BookAPIView视图。当用户访问/books/路径时，请求将被路由到BookAPIView的get方法进行处理。

总结

DRF是一个强大的Web API开发工具包，它提供了丰富的功能和工具，可以快速地构建出符合RESTful架构风格的API。本文介绍了DRF的基本使用方法，包括创建序列化器、创建视图、配置URL等步骤。希望这篇文章对你理解DRF的基本概念和使用方法有所帮助。

参考文献： [Django REST framework Documentation]( [Django REST framework Tutorial](