讲师中心 微信公众号
AI工具推荐 视频效率加速

如何使用Python Django开发符合RESTful规范的API?

梦瑶大大_6498

梦瑶大大_6498

发布时间:2026-07-25 09:34:06

|

366人浏览过

|

来源于php中文网

原创

DRF是最稳妥的API开发选择,因其内置序列化、请求解析、状态码、分页、权限等机制,避免原生Django手动处理导致的校验重复、分页混乱、状态码错误、更新绕过验证、错误格式不统一等问题。

如何使用python django开发符合restful规范的api?

直接用 Django REST Framework(DRF)是最稳妥的选择,原生 Django 虽然能写 API,但手动处理序列化、请求解析、状态码、分页、权限等会迅速失控。

为什么不能只靠 Django 的 JsonResponse 写 RESTful API

很多人一开始用 JsonResponse + request.method 分支写接口,很快就会遇到几个硬伤:

  • 每个视图都要重复写字段校验逻辑,request.POST.get("name") 或 json.loads(request.body) 容易漏判空值、类型错误
  • GET 查询参数(如 ?page=2&limit=20)要自己解析、拼 SQL,分页不一致、偏移越界没防护
  • HTTP 状态码全靠手写:status=400、status=404 很容易写错或遗漏
  • PUT/PATCH 更新时,无法自动区分“部分更新”和“全量更新”,Model.objects.filter().update() 会绕过模型验证
  • 没有统一的错误格式,前端收到 {"error": "missing field"} 和 {"detail": "Not found."} 混用,难以封装通用错误处理器

ModelSerializer 是 DRF 的核心起点,别跳过它直接写 APIView

哪怕你只打算暴露一个 Book 模型的列表和详情,也该先定义 BookSerializer。它不是“多此一举”,而是把三件事一次性绑定:

  • 字段映射:自动从 Book 模型读取 title、author、published_date,不用手写 dict 构造
  • 反向验证:POST/PUT 请求提交的数据,会按 max_length、required=True 等模型约束自动校验,失败时返回标准 400 Bad Request + 字段级错误信息
  • 嵌套支持:比如 author 是外键,加一行 author = AuthorSerializer(read_only=True) 就能展开关联数据,不用在视图里手动 .select_related() 再组装

示例(serializers.py):

立即学习“Python免费学习笔记(深入)”;

from rest_framework import serializers
from .models import Book
<p>class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = ['id', 'title', 'author', 'published_date']
read_only_fields = ['id']  # 防止客户端伪造 id

URL 路由必须匹配 HTTP 方法语义,别用 path('book/', ...) 承担所有操作

RESTful 不是“把接口都塞进一个 URL”,而是让路径表示资源、方法表示动作。常见错误是:

Galileo python sdk
Galileo python sdk

Galileo AI 平台 Python SDK 完整参考,用于评估、监控和保护 GenAI 应用,适用于构建 Python 应用。

下载
  • 所有操作都走 path('api/book/', views.book_handler),然后在视图里 if request.method == 'GET' 分支——这违背了 REST 的资源定位原则
  • 用 POST /api/book/delete/ 这种非标准路径删除资源,而不是 DELETE /api/book/123/
  • 版本控制缺失,上线后改接口不敢动 v1,只能新增 v2,导致路由爆炸

正确做法(urls.py):

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from . import views
<p>router = DefaultRouter()
router.register(r'book', views.BookViewSet, basename='book')  # 自动生成 GET/POST/PUT/DELETE</p><p>urlpatterns = [
path('api/v1/', include(router.urls)),  # 版本前缀清晰
]

DefaultRouter 会自动注册符合 REST 语义的路径:GET /api/v1/book/(列表)、POST /api/v1/book/(新建)、GET /api/v1/book/123/(详情)、PUT /api/v1/book/123/(全量更新)、DELETE /api/v1/book/123/(删除)

认证和权限必须提前配置,否则上线后补会牵一发而动全身

很多项目初期没设权限,所有接口裸奔,后期加 IsAuthenticated 时才发现:

  • BookViewSet 继承自 viewsets.ModelViewSet,默认没有任何权限限制,连 DELETE 都对游客开放
  • 全局配置 DEFAULT_PERMISSION_CLASSES 后,管理后台登录态(Session)和 API Token 无法共存,导致 admin 页面登不上
  • 第三方调用需要 TokenAuthentication,但忘了在 settings.py 中添加 'rest_framework.authtoken' 到 INSTALLED_APPS,迁移时报错 No migrations to apply

推荐最小可行配置(settings.py):

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.TokenAuthentication',
    ],
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticatedOrReadOnly',  # 列表和详情允许匿名读,写操作需登录
    ],
}

注意:IsAuthenticatedOrReadOnly 对 GET 放行,但 POST/PUT/DELETE 仍需登录;如果某接口真要完全公开(如注册),得在对应 ViewSet 里单独设 permission_classes = [AllowAny]。

真正麻烦的不是写第一个接口,而是当字段增加校验规则、关联关系变复杂、并发请求增多时,裸写逻辑的维护成本会指数上升。DRF 的约定不是束缚,是提前帮你踩过坑的护栏。

热门AI工具

更多
Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1691

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4284

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1689

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

24997

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3047

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3067

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1163

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

20

2026.10.10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Django 6.1 官方文档
Django 6.1 官方文档

共0课时 | 0人学习

Django 教程
Django 教程

共28课时 | 9.8万人学习

Django 教程
Django 教程

共8课时 | 11.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn