Django REST Framework 快速指南¶
简介¶
Django REST Framework (DRF) 是一个强大且灵活的工具包,用于构建Web API。
快速开始¶
1. 安装¶
pip install djangorestframework
pip install markdown
pip install django-filter
2. 配置¶
在 settings.py 中添加:
INSTALLED_APPS = [
...
'rest_framework',
]
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.SessionAuthentication',
],
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated',
]
}
基本概念¶
序列化器 (Serializers)¶
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = ['id', 'title', 'author', 'published_date']
视图 (Views)¶
from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer
class BookViewSet(viewsets.ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer
API端点¶
| HTTP方法 | URL | 描述 |
|---|---|---|
| GET | /api/books/ | 获取所有图书 |
| POST | /api/books/ | 创建新图书 |
| GET | /api/books/{id}/ | 获取特定图书 |
| PUT | /api/books/{id}/ | 更新图书 |
| DELETE | /api/books/{id}/ | 删除图书 |
提示:DRF自动为ModelViewSet生成这些标准的CRUD操作端点。
总结¶
DRF提供了构建RESTful API的完整解决方案,大大简化了API开发过程。