Python Django如何开发REST API_结合DRF实现序列化与路由

星明同学_9433

星明同学_9433

2026-04-05

212人浏览

原创

直接用 apiview 而非函数视图,因其自动解析 request.data 和 query_params、内置异常处理与响应封装;modelserializer 外键默认序列化为 id,可用 stringrelatedfield、primarykeyrelatedfield 或嵌套序列化器解决;api 路由应统一前缀并用 defaultrouter 管理;settings.py 中 default_renderer_classes、datetime_format、page_size 三项最易被忽略。

python django如何开发rest api_结合drf实现序列化与路由

为什么直接用 APIView 而不是函数视图写 REST 接口

函数视图(def 视图)写简单接口快,但一涉及请求体解析、字段校验、状态码控制、分页、权限判断,代码就迅速膨胀。而 APIView 是 DRF 的基础类视图,它自动处理了 request.data(JSON 解析)、request.query_params(代替 request.GET),还内置了异常处理器和响应封装。

常见错误是把 APIView 当成普通类视图用,忘了重写 get、post 等方法,或者漏掉 self.permission_classes = [...] 导致权限不生效。

  • 必须继承 APIView,不能只写个普通类
  • 方法名必须小写且匹配 HTTP 动词:get、post、put、delete
  • 返回必须用 Response(来自 rest_framework.response),不能用 Django 的 HttpResponse

如何让 ModelSerializer 正确处理外键和嵌套关系

ModelSerializer 默认把外键字段序列化成 ID,比如 author: 3,但前端通常需要作者名或完整对象。这不是 bug,是设计选择——避免 N+1 查询和循环引用。

要显示关联字段内容,有三个常用方式:

  • 用 StringRelatedField:适合只读展示,如 author = serializers.StringRelatedField(read_only=True) → 输出 "author": "Alice"
  • 用 PrimaryKeyRelatedField:支持读写,但写入时传 ID 即可,如 author = serializers.PrimaryKeyRelatedField(queryset=User.objects.all())
  • 用嵌套序列化器:需手动定义 author = UserSerializer(read_only=True),但要注意加 read_only=True 或在 create() 中重写逻辑,否则保存会报错

容易踩的坑:在嵌套序列化器中没设 read_only=True,又没重写 create 方法,POST 时就会触发 TypeError: Object of type User is not JSON serializable。

URL 路由怎么配才不和 Django 普通路由冲突

DRF 推荐把 API 路由集中到一个 api/ 前缀下,并用 DefaultRouter 或 SimpleRouter 自动生成 CRUD 路径。别在主 urls.py 里用 path('', ...) 直接挂载,否则可能被前面的 path('<slug>/', ...)</slug> 拦截。

huaweicloud-python-sdk-helper
huaweicloud-python-sdk-helper

华为云 Python SDK 查询工具。自动发现已安装 SDK 的服务包、Client类、API 方法、入参详情、类信息(__init__ 参数、属性、类型、描述),支持关键字搜索,快速定位目标 API 使用方法。

下载

典型配置方式:

# api/urls.py
from rest_framework.routers import DefaultRouter
from .views import BookViewSet
<p>router = DefaultRouter()
router.register(r'books', BookViewSet, basename='book')
urlpatterns = router.urls
</p>

然后在主 urls.py 中 include:

path('api/', include('myapp.api.urls')),
  • basename 必须显式指定,尤其当视图集没有 queryset 属性时(比如用 get_queryset() 动态返回)
  • 不要在 BookViewSet 的 list 方法里手动写 return JsonResponse(...),这会绕过 DRF 的渲染器和内容协商
  • 如果要用非标准动作(如 /books/latest/),得加 @action(methods=['get'], detail=False),并确认是否需要 url_path 参数

settings.py 里哪些 DRF 配置项最容易被忽略

很多项目跑起来没问题,但上线后发现分页失效、时间格式混乱、404 返回 HTML 而不是 JSON——问题常出在全局配置漏设。

以下三项必须检查:

  • REST_FRAMEWORK['DEFAULT_RENDERER_CLASSES']:至少包含 'rest_framework.renderers.JSONRenderer',否则浏览器直接访问 API URL 会返回 HTML 页面
  • REST_FRAMEWORK['DATETIME_FORMAT']:默认是 'iso-8601',但若前端要求 '%Y-%m-%d %H:%M:%S',就得显式覆盖,否则时间字段序列化后是字符串但格式不符
  • REST_FRAMEWORK['PAGE_SIZE']:不设的话分页器不会自动启用;配合 'DEFAULT_PAGINATION_CLASS' 才生效,缺一不可

另外,开发期建议加上 'rest_framework.renderers.BrowsableAPIRenderer' 到 DEFAULT_RENDERER_CLASSES,它提供网页调试界面,但生产环境务必移除——否则暴露敏感字段和测试入口。

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

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

python django

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4604

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

27237

23

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

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

2023.08.04

3287

5

python eval
python eval

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

2023.08.04

3307

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2563

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习