Django API怎么写_Django REST framework(DRF)快速入门

云杰小哥_7054

云杰小哥_7054

2026-03-25

627人浏览

原创

90%的crud场景应选modelviewset,它内置增删改查、序列化、分页和权限;非标操作(如导出excel)才用apiview;viewset需配合router注册,apiview需显式调用as_view()。

django api怎么写_django rest framework(drf)快速入门

DRF 的 APIView 和 ViewSet 到底该选哪个?

新手写 API 时最常卡在这一步:用 APIView 还是 ViewSet?答案很直接——90% 的 CRUD 场景直接上 ModelViewSet,它自带增删改查逻辑、序列化、分页、权限检查,不用手写 get/post 方法。只有当你需要非标行为(比如导出 Excel、触发异步任务、聚合多个模型)才退回到 APIView。

容易踩的坑:ViewSet 必须配 Router 才能注册路由,光写类不加 urls.py 里的 router.register(),接口根本不会出现;而 APIView 是传统路径绑定,容易漏写 as_view()。

  • ModelViewSet 默认支持 list、retrieve、create、update、destroy 五个动作,对应 HTTP 方法自动映射
  • 想禁用某个动作(比如不允许删除),直接在类里加 http_method_names = ['get', 'post', 'put']
  • 如果要复用同一套序列化逻辑但返回不同字段,别硬改 Serializer 类,用 fields 动态控制更安全

序列化器 Serializer 怎么写才不翻车?

DRF 的核心不是视图,是 Serializer。它既做数据校验,又管字段转换,还影响 API 返回结构。很多人把 ModelSerializer 当成“自动映射模型”,结果字段类型错、空值报错、外键嵌套没展开,全在这儿崩。

常见错误现象:ValidationError: {'name': ['This field is required.']} 明明前端传了却报缺字段,大概率是 Serializer 没设 required=False 或 allow_blank=True;或者用了 read_only=True 却想在 POST 时写入。

  • ModelSerializer 默认只包含 model 的 fields 列表里声明的字段,漏写就不出现在请求/响应里
  • 外键字段默认只返回 ID,要显示关联字段内容,得用 StringRelatedField 或嵌套 Serializer,但注意 N+1 查询问题
  • to_representation 可以定制输出结构,但别在里面做数据库查询;to_internal_value 适合预处理输入,比如把字符串时间转成 datetime

settings.py 里这三行配置不加,API 就跑不稳

DRF 不是装完就能用,有三个基础配置项漏掉一个,轻则分页失效、跨域报错,重则整个 API 返回 500 却不报具体原因。

Django
Django

避免常见的 Django 错误——QuerySet 评估、N+1 查询、迁移冲突和 ORM 陷阱。

下载

最容易被忽略的是 DEFAULT_RENDERER_CLASSES:不显式声明,Django 默认用 HTML 渲染器,浏览器访问 API 页面会渲染成网页,但 Postman/curl 却拿不到 JSON,还以为是代码问题。

  • 必须加 'DEFAULT_AUTHENTICATION_CLASSES',哪怕暂时用 SessionAuthentication,否则登录态无法透传到 API 层
  • 'DEFAULT_PAGINATION_CLASS' 和 'PAGE_SIZE' 要一起设,不然 list 接口一次返回全部数据,列表一多就拖垮数据库
  • 开发环境建议打开 'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema'(需额外装 drf-spectacular),不然连 Swagger 都起不来

为什么 POST 请求总返回 403?CSRF 和 Token 到底怎么配?

本地调试时,浏览器发 POST 报 403 Forbidden,十有八九是 CSRF 校验没绕过。DRF 默认继承 Django 的 CSRF 机制,但 API 场景下不该依赖 session cookie,得切到 token 认证。

关键点在于:CSRF 保护只对 SessionAuthentication 生效,如果你用了 TokenAuthentication 或 JWT,反而要关掉 CSRF 检查,否则每次请求都得带 X-CSRFToken 头,前端根本不知道从哪取。

  • 使用 TokenAuthentication 时,在视图类里明确写 authentication_classes = [TokenAuthentication],并确保请求头带 Authorization: Token xxxxx
  • 若前后端分离(如 Vue/React),后端 settings.py 中应禁用 django.middleware.csrf.CsrfViewMiddleware,或用 @csrf_exempt 包裹特定 API 视图(仅限调试)
  • Token 不是自动创建的,用户注册/登录后得手动调用 Token.objects.get_or_create(user=user),否则前端拿不到 token

复杂点在于认证链路:前端存 token 的位置(localStorage 还是 httpOnly cookie)、过期策略、刷新机制,这些 DRF 本身不处理,得靠 djangorestframework-simplejwt 或自己补。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

django

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4224

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24557

23

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

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

2023.08.04

3007

5

python eval
python eval

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

2023.08.04

3027

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2343

5

热门下载

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

精品课程

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

共0课时 | 0人学习

Django 教程
Django 教程

共28课时 | 9.8万人学习

Django DRF 源码解析
Django DRF 源码解析

共21课时 | 2万人学习