Django REST Framework 中文文档教程

Django REST Framework 中文文档教程

Django-REST-framework-documentationThe translation of documentation for the version 3 of REST framework.（Only dev branch-based PR will be accepted. ）项目地址:https://gitcode.com/gh_mirrors/dj/Django-REST-framework-documentation

项目介绍

Django REST Framework（DRF）是一个强大且灵活的工具包，用于构建 Web API。以下是您可能想要使用 DRF 的一些原因：

• Web 可浏览的 API：为您的开发人员提供巨大的可用性。
• 认证策略：包括 OAuth1a 和 OAuth2 的包。
• 序列化：支持 ORM 和非 ORM 数据源的序列化。
• 可定制性：从简单的现成视图到高度定制的行为。
• 分页、过滤、排序 和 版本控制 的支持。

项目快速启动

安装

首先，使用 pip 安装 Django REST Framework：

pip install djangorestframework

创建 Django 项目

创建一个新的 Django 项目：

django-admin startproject myproject
cd myproject

添加 DRF 到 INSTALLED_APPS

在 myproject/settings.py 中添加 rest_framework：

INSTALLED_APPS = [
    ...
    'rest_framework',
]

创建一个简单的 API

创建一个新的应用：

python manage.py startapp myapp

在 myapp/models.py 中创建一个简单的模型：

from django.db import models

class Item(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()

创建序列化器 myapp/serializers.py：

from rest_framework import serializers
from .models import Item

class ItemSerializer(serializers.ModelSerializer):
    class Meta:
        model = Item
        fields = '__all__'

创建视图 myapp/views.py：

from rest_framework import viewsets
from .models import Item
from .serializers import ItemSerializer

class ItemViewSet(viewsets.ModelViewSet):
    queryset = Item.objects.all()
    serializer_class = ItemSerializer

配置路由 myapp/urls.py：

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

router = DefaultRouter()
router.register(r'items', ItemViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

在 myproject/urls.py 中包含应用的路由：

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

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('myapp.urls')),
]

运行开发服务器：

python manage.py runserver

现在，您可以通过访问 http://127.0.0.1:8000/api/items/ 来查看和操作您的 API。

应用案例和最佳实践

认证和权限

DRF 提供了多种认证和权限选项，包括：

• BasicAuthentication
• TokenAuthentication
• SessionAuthentication
• OAuthAuthentication

在视图中配置认证和权限：

from rest_framework import permissions

class ItemViewSet(viewsets.ModelViewSet):
    queryset = Item.objects.all()
    serializer_class = ItemSerializer
    permission_classes = [permissions.IsAuthenticated]

分页

DRF 提供了多种分页方式，例如：

from rest_framework.pagination import PageNumberPagination

class StandardResultsSetPagination(PageNumberPagination):
    page_size = 10
    page_size_query_param = 'page_size'
    max_page_size = 100

在视图中使用分页：

class ItemViewSet(viewsets.ModelViewSet):
    queryset = Item.objects.all()
    serializer_class = ItemSerializer
    pagination_class = StandardResultsSetPagination

典型生态项目

第三方包

DRF 社区

Django-REST-framework-documentationThe translation of documentation for the version 3 of REST framework.（Only dev branch-based PR will be accepted. ）项目地址:https://gitcode.com/gh_mirrors/dj/Django-REST-framework-documentation