0

0

Python Django怎么写API_DRF ViewSet视图集与Router自动生成多动作高标准接口

P粉602998670

P粉602998670

发布时间:2026-03-16 10:08:47

|

318人浏览过

|

来源于php中文网

原创

ViewSet 的 list/retrieve/update 等动作需通过 DefaultRouter 或 SimpleRouter 自动绑定 URL,不配 Router 则仅为普通方法;必须设置 queryset 和 serializer_class(或重写 get_serializer_class)否则报错。

python django怎么写api_drf viewset视图集与router自动生成多动作高标准接口

ViewSet 里 list/retrieve/update 这些动作怎么自动绑定到 URL?

DRF 的 ViewSet 本身不直接响应请求,必须配合 Router 才能生成标准 REST 路由。不配 router,listretrieve 就只是普通方法,不会被 URL 访问到。

  • DefaultRouter(推荐)或 SimpleRouter,别手写 path() 去映射每个动作
  • DefaultRouter 会额外提供根路径(/api/)的 API 文档索引页,SimpleRouter 不带这个,更轻量
  • 注册时必须传视图集类名,不是实例:router.register(r'users', UserViewSet),不是 UserViewSet()
  • 如果视图集没定义 querysetretrieve/update 等依赖对象查找的动作会报 AssertionError: 'UserViewSet' should either include a `queryset` attribute

为什么 get_serializer_class() 比 serializer_class 更灵活?

一个 ViewSet 经常要对不同动作返回不同字段(比如 list 只返回 id/name,retrieve 返回全部),硬写死 serializer_class 会导致序列化逻辑耦合、字段冗余甚至 400 错误。

  • get_serializer_class() 是钩子方法,在每次请求时动态返回序列化器类,适合按动作区分
  • 常见写法是用 self.action 判断当前动作名:if self.action == 'list': return UserListSerializer
  • 注意:不要在 get_serializer_class() 里返回实例(如 UserSerializer()),必须返回类(UserSerializer
  • 如果用了 GenericAPIView 的 mixin(比如 RetrieveModelMixin),但没设 serializer_class 且没重写 get_serializer_class,会直接报 AttributeError: 'UserViewSet' object has no attribute 'serializer_class'

自定义动作(@action)加了 detail=True 却 404?

加了 @action(detail=True) 的方法,默认 URL 是 /api/users/{id}/xxx/,但如果你访问的是 /api/users/xxx/(少了个 ID),就会 404 —— 不是路由没注册,是路径根本匹配不上。

  • detail=True 表示该动作作用于单个对象,URL 必须含主键参数;detail=False 才走集合级路径
  • 确保前端调用时路径拼对了,特别是 ID 是否传入、是否被 URL 编码(比如 UUID 中的短横线)
  • 自定义动作默认只允许 GET,如需 POST,得显式写 @action(detail=True, methods=['post'])
  • 如果用了 url_path 自定义路径名(比如 @action(url_path='profile')),生成的 URL 是 /api/users/{id}/profile/,别漏掉末尾斜杠(Django 默认要求 trailing slash)

Router 注册后 URL 冲突或 405 Method Not Allowed 怎么查?

冲突往往不是代码写错,而是多个视图集注册了相同 prefix,或者自定义 action 和内置动作同名(比如自己写了个叫 create@action)。

iMuse.AI
iMuse.AI

iMuse.AI 创意助理,为设计师提供无限灵感!

下载

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

  • 运行 python manage.py show_urls(需装 django-extensions)看实际注册的路由表,确认路径和 HTTP 方法是否符合预期
  • 405 常见于:该动作没在 methods 列表里声明,或视图集继承了 ReadOnlyModelViewSet 却试图调 update
  • 同一个 ViewSet 里不要同时定义 update() 方法和 @action(methods=['put'], detail=True),否则 PUT /{id}/ 会歧义,DRF 优先走内置动作
  • 如果用了 basename 参数(如 router.register(r'users', UserViewSet, basename='user')),确保它唯一且不含特殊字符,否则反向解析 URL 会失败

最常被忽略的是 querysetserializer_class 的存在性检查 —— 它们不是可选配置,而是 DRF 在初始化阶段就强制校验的属性,出错提示往往藏在中间件或 mixin 的底层,而不是你的视图代码里。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Web 框架 Django 深度开发
Python Web 框架 Django 深度开发

本专题系统讲解 Python Django 框架的核心功能与进阶开发技巧,包括 Django 项目结构、数据库模型与迁移、视图与模板渲染、表单与认证管理、RESTful API 开发、Django 中间件与缓存优化、部署与性能调优。通过实战案例,帮助学习者掌握 使用 Django 快速构建功能全面的 Web 应用与全栈开发能力。

169

2026.02.04

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

184

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

226

2025.12.18

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

847

2023.08.22

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1998

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

681

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2418

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

49

2026.01.19

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

90

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号