跳转到内容
主菜单
主菜单
移至侧栏
隐藏
导航
首页
最近更改
随机页面
MediaWiki帮助
代码酷
搜索
搜索
中文(中国大陆)
外观
创建账号
登录
个人工具
创建账号
登录
未登录编辑者的页面
了解详情
贡献
讨论
编辑“︁
Django REST framework
”︁
页面
讨论
大陆简体
阅读
编辑
编辑源代码
查看历史
工具
工具
移至侧栏
隐藏
操作
阅读
编辑
编辑源代码
查看历史
常规
链入页面
相关更改
特殊页面
页面信息
外观
移至侧栏
隐藏
您的更改会在有权核准的用户核准后向读者展示。
警告:
您没有登录。如果您进行任何编辑,您的IP地址会公开展示。如果您
登录
或
创建账号
,您的编辑会以您的用户名署名,此外还有其他益处。
反垃圾检查。
不要
加入这个!
= Django REST framework = '''Django REST framework'''(简称DRF)是一个基于[[Django]]框架构建的强大且灵活的工具包,用于开发[[Web API]]。它提供了构建[[RESTful API]]所需的各种组件,包括序列化、视图、认证、权限控制等机制。 == 主要特性 == Django REST framework的核心功能包括: * 强大的序列化系统,支持ORM和非ORM数据源 * 可扩展的视图和视图集 * 内置的认证方案([[OAuth]]、Token等) * 自定义权限控制 * 可浏览的API界面 * 支持多种响应格式(JSON、XML等) == 安装与配置 == 要使用Django REST framework,首先需要安装: <syntaxhighlight lang="bash"> pip install djangorestframework </syntaxhighlight> 然后在Django项目的settings.py中添加: <syntaxhighlight lang="python"> INSTALLED_APPS = [ ... 'rest_framework', ] </syntaxhighlight> == 基本使用示例 == 以下是一个简单的API示例,展示如何创建图书模型的CRUD接口: 1. 首先定义模型: <syntaxhighlight lang="python"> # models.py from django.db import models class Book(models.Model): title = models.CharField(max_length=100) author = models.CharField(max_length=100) published_date = models.DateField() </syntaxhighlight> 2. 创建序列化器: <syntaxhighlight lang="python"> # serializers.py from rest_framework import serializers from .models import Book class BookSerializer(serializers.ModelSerializer): class Meta: model = Book fields = ['id', 'title', 'author', 'published_date'] </syntaxhighlight> 3. 编写视图: <syntaxhighlight lang="python"> # views.py from rest_framework import viewsets from .models import Book from .serializers import BookSerializer class BookViewSet(viewsets.ModelViewSet): queryset = Book.objects.all() serializer_class = BookSerializer </syntaxhighlight> 4. 配置URL路由: <syntaxhighlight lang="python"> # urls.py from django.urls import path, include from rest_framework.routers import DefaultRouter from .views import BookViewSet router = DefaultRouter() router.register(r'books', BookViewSet) urlpatterns = [ path('', include(router.urls)), ] </syntaxhighlight> == 认证与权限 == Django REST framework提供了多种认证方式: * Token认证 * Session认证 * Basic认证 * OAuth/JWT认证 示例:限制API仅对认证用户开放 <syntaxhighlight lang="python"> REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.IsAuthenticated', ] } </syntaxhighlight> == 实际应用案例 == Django REST framework被许多知名公司和项目使用: * [[Instagram]] - 用于构建内部API * [[Mozilla]] - 部分Web服务的API实现 * [[Eventbrite]] - 活动管理平台的API * [[Red Hat]] - 部分管理接口 == 性能优化 == 对于高流量API,可以考虑以下优化策略: * 使用分页限制响应大小 * 实现缓存策略 * 优化数据库查询 * 使用[[Django Debug Toolbar]]分析性能瓶颈 == 生态系统扩展 == DRF有丰富的第三方扩展: * [[django-filter]] - 添加过滤功能 * [[drf-yasg]] - 生成Swagger文档 * [[djangorestframework-simplejwt]] - JWT认证支持 == 参见 == * [[Django]] * [[REST]] * [[API设计]] * [[GraphQL]] == 参考资料 == * 官方文档:https://www.django-rest-framework.org/ * GitHub仓库:https://github.com/encode/django-rest-framework [[Category:Web框架]] [[Category:Django]] [[Category:API]]
摘要:
请注意,所有对代码酷的贡献均被视为依照知识共享署名-非商业性使用-相同方式共享发表(详情请见
代码酷:著作权
)。如果您不希望您的文字作品被随意编辑和分发传播,请不要在此提交。
您同时也向我们承诺,您提交的内容为您自己所创作,或是复制自公共领域或类似自由来源。
未经许可,请勿提交受著作权保护的作品!
取消
编辑帮助
(在新窗口中打开)