1、DRF实战总结：DRF特点、序列化与RESTful API规范

已于 2023-06-28 17:02:53 修改
阅读量3.3k 收藏 7
点赞数
分类专栏： # Django进阶 文章标签： django python 后端 RESTful API 开发规范
于 2023-03-25 20:00:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhouruifu2015/article/details/129761606
版权

注意：后续技术分享，第一时间更新，以及更多更及时的技术资讯和学习技术资料，将在公众号CTO Plus发布，请关注公众号：CTO Plus  

 

Django这种基于MVC开发模式的传统框架，非常适合开发基于PC的传统网站，因为它同时包括了后端的开发(逻辑层、数据库层) 和前端的开发(如模板语言、样式)。现代网络应用Web APP或大型网站一般是一个后台，然后对应各种客户端(iOS, android, 浏览器)。由于客户端的开发语言与后台的开发语言经常不一样，这时需要后台能够提供可以跨平台跨语言的一种标准的资源或数据(如json或xml)供前后端沟通，这就是Web API(网络应用程序接口)的作用了。

Django REST Framework介绍与特点

Django REST framework是一个强大且灵活的工具包，用以构建Web APIs。Django的未来与Web开发未来发展趋势紧密相关。Django本身并不是为了开发符合REST规范的Web API而设计, 不过借助Django REST Framework (DRF)这个神器可以快速开发出优秀而且规范的Web API来。Django REST framework 给Django提供了用于构建Web API 的强大而灵活的工具包, 包括序列化器、认证、权限、分页、过滤和限流。

DRF特点：

  1. 提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其他库自动序列化/反序列化；
  2. 提供了丰富的类视图和Mixin扩展类，可以进一步简化视图的编写；
  3. 多种身份认证和权限认证方式的支持；
  4. 内置了限流系统；
  5. 直观的API Web界面；
  6. 可扩展性, 插件丰富；
  7. 完备的文档以及良好的社区支持；
  8. 同时支持ORM和非ORM数据源的序列化；
  9. 可以配置各个环节，若无需更多强大的特性，使用一般基于类（function-based）的视图（views）即可。

Django REST Framework的安装

Django REST framework (DRF)是基于Django实现的一个RESTful风格API框架，能够帮助快速开发RESTful风格的API。

使用pip安装DRF：pip install djangorestframework

如果想要获取一个图形化的页面来操作API，需要将 rest_framework 注册到项目的INSTALL_APPS中，如下所示：

INSTALLED_APPS = [
    # 默认APP
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # 新安装第三方APP
    'rest_framework',
    'rest_framework_mongoengine',
    # 将自己新建的APP应用（people）添加到 settings.py中的INSTALLED_APPS中，告诉Django有这么一个应用
    ……
]

安装和注册好DRF，但在正式使用它开发API前还需要了解两件事情。什么是数据的序列化(Serialization)以及什么是RESTful规范的API, 这对于理解DRF中的序列化serializers类和每个API端点对应的url设计至关重要。

序列化基础知识

每种编程语言都有各自的数据类型, 将属于自己语言的数据类型或对象转换为可通过网络传输或可以存储到本地磁盘的数据格式（如：XML、JSON或特定格式的字节串）的过程称为序列化(seralization)；反之则称为反序列化。API开发的本质就是各种后端语言的自己的数据类型序列化为通用的可读可传输的数据格式，比如常见的JSON类型数据。

Python数据序列化

Python自带json模块的dumps方法可以将python常用数据格式（比如列表或字典)转化为json格式,如下所示。注意到了吗? 生成的json格式数据外面都加了单引号，这说明dict类型数据已经转化成了json字符串。

import json

infos = {"name": "SteveRocket", "language": "Python", "version": 3.11}
dump_infos = json.dumps(infos)
print(dump_infos, type(dump_infos))
输出：{"name": "SteveRocket", "language": "Python", "version": 3.11} <class 'str'>

Django查询集序列化

Django还有自己专属的数据类型比如查询集QuerySet和ValueQuerySet类型数据，还提供了自带的serializers类。使用Django自带的serializers类也可以轻易将QuerySet格式的数据转化为json格式。

# Django Queryset数据 to Json
from django.core import serializers
from drf_pro.models import SerializerDemo

peoples = serializers.serialize("json", SerializerDemo.objects.all())
peoples2 = serializers.serialize("json", SerializerDemo.objects.all(), fields=("name", "id"))
people = serializers.serialize("json", SerializerDemo.objects.filter(name="SteveRocket"))

有时候只需要查询结果集的部分字段，可以使用values('字段名','字段名2')来要求返回所需要的数据，可以提升些性能，但是返回来的结果需要先转换成列表格式，再用 json.dumps()方法序列化成json格式。

import json
from django.core.serializers.json import DjangoJSONEncoder
value_query_set = SerializerDemo.objects.filter(name="SteveRocket").values("age", "description")
people_desc = json.dumps(list(value_query_set), cls=DjangoJSONEncoder)

尽管Django自带的serializers类也能将Django的查询集QuerySet序列化成json格式数据，Django REST Framework才是真正需要的序列化工具。与django自带的serializers类相比，DRF的序列化器更强大，可以根据模型生成序列化器，还能对客户端发送过来的数据进行验证。

RESTful API

REST ful是目前最流行的API设计规范，用于Web数据接口的设计。是Rest式的接口，REST与技术无关，它代表的是一种软件架构风格。

REST是REpresentational State Transfer三个单词的缩写，，中文的含义是: "表征状态转移" 或 "表现层状态转化"。由Roy Fielding于2000年论文中提出。简单来说，就是用URI表示资源，用HTTP方法(GET, POST, PUT, DELETE)表征对这些资源进行增删查改的操作。

是基于HTTP、URI、XML、JSON等标准和协议，支持轻量级、跨平台、跨语言的架构设计。

RESTful API 可以通过一套统一的接口为所有web相关提供服务，实现前后端分离。

RESTful API原则

  1. 每一个URI代表一种资源。
  2. 同一种资源有多种表现形式(xml/json)。
  3. 所有的操作都是无状态的。
  4. 规范统一接口。
  5. 返回一致的数据格式。
  6. 可缓存(客户端可以缓存响应的内容)。

如果要想编写的API被称为RESTful api，只要遵循其规定的约束即可。

为什么所有的操作都是无状态的?

http请求本身是无状态的，它是基于 client-server 架构，客户端向服务器端发的每一次请求都必须带有充分的信息能够让服务器端识别到，请求的一些信息通常会包含在URL的查询参数、header或请求体中，服务器端能够根据请求的各种参数, 不需要保存客户端的状态, 直接将数据返回给客户端。无状态的优点是：可以大大提高服务器端的健状性和可扩展性。

客户端可以通过token来标识会话状态。从而可以让该用户一直保持登录状态。

RESTful API规范

REST接口约束定义为: 资源识别；请求动作；响应信息; 它表示通过uri表示出要操作的资源，通过请求动作(http method)标识要执行的操作，通过返回的状态码来表示这次请求的执行结果。

协议、域名和版本

尽量使用https协议，使用专属域名来提供API服务。API版本可以放在URL里面，也可以用HTTP的header进行内容协商，如下所示：

https://api.example.com/v1
https://www.example.com/api/v1

uri(统一资源标识符)

在RESTful架构中，每个网址代表一种资源（resource），这个网络地址就是uri (uniform resource identifier), 有时也被称为URL (uniform resource locator)。 因为URI对应一种资源，所以里面不能有动词，只能有名词。一般来说，数据库中的表都是同种记录的”集合”（collection），所以API中的名词也应该使用复数形式。

https://api.example.com/v1/users # 用户列表资源地址
https://api.example.com/v1/users/{id} # 用户id=5对应资源。注意：这里是users/5，而不是user/5
https://api.example.com/v1/users/{id}/articles # 用户id=5发表的文章列表

如果需要对一个用户信息进行编辑或删除，一个传统Django开发者可能将URL写成如下所示：

https://api.example.com/v1/users/{id}/edit/ # 编辑用户
https://api.example.com/v1/users/{id}/delete/ # 删除用户

上面URL设计其实是不符合RESTful规范的。一个 URI就应该是一个资源，本身不能包含任何动作 (action)。REST的规范是资源的URI地址是固定不变的，对同一资源应使用不同的HTTP请求方法进行不同的操作，比如常见的增删查改。

[POST]    https://api.example.com/v1/users   // 新增
[GET]     https://api.example.com/v1/users/1 // 查询
[PATCH]   https://api.example.com/v1/users/1 // 更新
[PUT]     https://api.example.com/v1/users/1 // 覆盖，全部更新
[DELETE]  https://api.example.com/v1/users/1 // 删除

有时候URL比较长，可能由多个单词组成，建议使用中划线”-“分割，而不是下划线”_“作为分隔符，另外每个url的结尾不能加斜线”/”。

https://api.example.com/v1/user-management/users/{id} # 好
https://api.example.com/v1/user_management/users/{id} # 不好
https://api.example.com/v1/user-management/users/{id}/ # 不好

参数命名规范

参数推荐采用下划线命名的方式。

http://127.0.0.1/api/today_login               // 获取今天登录的用户。

http://127.0.0.1/api/today_login&sort=login_desc // 获取今天登录的用户、登录时间降序排序。

HTTP请求方法

常用的HTTP请求方法有下面五个（括号里是对应的SQL命令)，每个方法对应一个操作。客户端在消费服务器提供的API服务时不仅要指定请求地址，还需指定请求方法。

	GET（SELECT）：查询；从服务器取出资源（一项或多项）。
	POST（CREATE）：新增;在服务器新建一个资源。
	PUT（UPDATE）：更新;在服务器更新资源（客户端提供改变后的完整资源）。
	PATCH（UPDATE）：更新；在服务器更新资源（客户端提供改变的属性）。
	DELETE（DELETE）：删除;从服务器删除资源。

另外还有两个不常用方法HEAD和OPTIONS，HEAD和GET本质是一样的，区别在于：

HEAD不含有呈现数据，而仅仅是HTTP头信息，请求的是资源的元数据，比如一张照片的元数据则可能包含了，照片拍摄的设备，地点，时间等。服务器一般将对应资源的元数据置于响应的报头集合返回给客户端，这样的响应一般不具有主体部分。

OPTIONS极少使用，它主要用于获取当前URL所支持的方法，发送一种“探测”请求以确定针对某个目标地址的请求必须具有怎样的约束（比如应该采用怎样的HTTP方法以及自定义的请求报头），然后根据其约束发送真正的请求。

HTTP状态码（Status Codes）

服务器在处理客户端请求后还应向用户返回响应的状态码和提示信息，DRF给出Respone时可以指定各种各样状态码，很容易使用，常见的有以下一些状态码。

1xx: 信息，请求收到了，继续处理。

2xx: 代表成功. 行为被成功地接收、理解及采纳。

3xx: 重定向。

4xx: 客户端错误，请求包含语法错误或请求无法实现。

5xx: 服务器端错误。

2xx 状态码

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功

4xx状态码

400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
405：Method Not Allowed: 用户已经通过了身份验证, 但是所用的HTTP方法不在它的权限之内。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
415: Unsupported Media Type: 客户端要求的返回格式不支持，比如，API只能返回JSON格式，但是客户端要求返回XML格式。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
429：Too Many Requests: 客户端的请求次数超过限额。

5xx 状态码

500 INTERNAL SERVER ERROR - [*]：服务器发生错误
502：网关错误。
503: Service Unavailable 服务器端当前无法处理请求。
504：网关超时。

过滤信息（filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。符合RESTful规范的API应该支持过滤，DRF与django-filter可以轻松实现过滤。下面是一些常见的通过参数过滤的方式。

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个姓名排序，以及排序顺序。
?user_type_id=1：指定筛选条件，比如用户类型。

统一返回数据格式

Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。比如，当用户向127.0.0.1的根目录发出请求，会得到这样一个文档，DRF支持HyperLinkedModel，很容易实现这点。

{
"link": {
       "rel":   "collection https://127.0.0.1/zoos",
       "href":  "https://api.example.com/zoos",
       "title": "List of zoos",
       "type":  "application/vnd.yourformat+json"
}
}

返回的数据格式

RESTful规范中的请求应该返回统一的数据格式。对于返回的数据，一般会包含如下字段:

1) code: http响应的状态码。

2) status: 包含文本, 比如：'success'(成功), 'fail'(失败), 'error'(异常)

HTTP状态响应码在500-599之间为 'fail'; 在400-499之间为 'error', 其他一般都为 'success'。对于响应状态码为 1xx, 2xx, 3xx 这样的可以根据实际情况可要可不要。

当status的值为 'fail' 或 'error'时，需要添加 message 字段，用于显示错误信息。

3) data: 当请求成功的时候, 返回的数据信息。但是当状态值为 'fail' 或 'error' 时，data仅仅包含错误原因或异常信息等。

响应成功的示例：

{
    "code": 200,
    "status": "success",
    "data": [{
        "userName": "tugenhua",
        "age": 31
    }]
}

响应失败的示例：

{
    "code": 401,
    "status": "error",
    "message": '用户没有权限',
    "data": null
}

参考资料

输入才有输出，吸收才能吐纳。——码字不易

更多资料 · 微信公众号搜索【CTO Plus】关注后，获取更多，我们一起学习交流。

关于公众号的描述访问如下链接

关于Articulate“做一个知识和技术的搬运工。做一个终身学习的爱好者。做一个有深度和广度的技术圈。”一直以来都想把专业领域的技https://mp.weixin.qq.com/s/0yqGBPbOI6QxHqK17WxU8Q

SteveRocket
关注
  • 0
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
DRF初始-序列化与反序列化
大雪纷斐的博客
09-06 161
drf1.0
【DRF】DRF框架的介绍和安装、RESTful规范（1）
python全栈
05-10 945
一、为什么学习DRF Django的未来与Web开发未来发展趋势紧密相关。Django这种基于MVT开发模式的传统框架，⾮常适合开发基于PC的传统⽹站，因为它同时包括了后端的开发(逻辑层，数据库层) 和前端的开发(如模板语⾔，样式)。 然⽽最近⼏年及未来⼏年更流⾏的开发模式肯定是前后端分离, Django也需要做出⾃⼰的改变来适应这种开发模式。现代⽹络应⽤Web APP或⼤型⽹站⼀般是⼀个后台，然后对应各种客户端(IOS, Android, 浏览器)。由于客户端的开发语⾔与后台的开发语⾔经常不⼀样，这时需要
Django API开发实战：前后端分离、Restful风格与DRF序列化器详解
啊猪是的读来过倒的博客
06-09 2273
在当今互联网开发中，前后端分离架构和Restful风格API成为主流。本文将深入探讨前后端分离、Restful风格、接口文档的概念，并重点介绍DRF（Django-Rest-Framework）的使用，包括APIView处理请求与响应的方法，以及序列化的重要性。
1-drf-Web开发模式、API接口、restful规范、序列化和反序列化、drf安装和快速使用、路由转换器(复习)
linjun的博客
08-29 2013
Web开发模式、API接口、restful规范、序列化和反序列化、drf安装和快速使用
3、DRF实战总结：基于类的视图APIView, GenericAPIView和GenericViewSet视图集（附源码）
SteveRocket's-Blog
03-27 1217
DRF提供了4种编写CBV类API的方式，到底哪种CBV开发模式更好? 答案是各有利弊 o 基础的API类：可读性最高，代码最多，灵活性最高。当需要对API行为进行个性化定制时，建议使用这种方式。 o 通用generics.*类：可读性好，代码适中，灵活性较高。当需要对一个模型进行标准的增删查改全部或部分操作时建议使用这种方式。 o 使用视图集viewset: 可读性较低，代码最少，灵活性最低。当需要对一个模型进行标准的增删查改的全部操作且不需定制API行为时建议使用这种方式。
Drf从入门到精通一（API接口、Postman、Restful规范、序列化、快速使用drf、CBV源码分析）
主要发布一些日常学习代码及理解
09-24 2126
详细介绍了Drf从入门到精通一（API接口、Postman、Restful规范、序列化、快速使用drf、CBV源码分析）
【Django】DRF自定义序列化器、序列化与反序列化
冰冷的希望的博客
09-20 3658
使用Django前后端分离开发的情况下，我们经常需要把处理后的数据按照一定的格式（比如说json）返回，或者把前端传过来的数据进行处理才能进行数据库的CURD。而DRF（Django REST Framework）就可以帮忙我解决这个问题，即序列化和反序列化 1.安装DRF 使用pip安装 pip install djangorestframework 配置应用 INSTALLED_APPS = [ ... 'rest_framework', ] 2.定义Serializer 我们新建一
2、DRF实战总结：基于函数的视图API以及自定义序列化器（附源码）
SteveRocket's-Blog
03-26 934
前面介绍了什么是DRF，什么是序列化以及什么是符合RESTful规范的Web API。本篇使用DRF提供的序列化器(Serializers类)，基于函数视图开发两个API接口并测试。 https://blog.csdn.net/zhouruifu2015/article/details/129648966?spm=1001.2014.3001.5501 需要值得注意的有以下几点： 1. 定义序列化器时一定要注意区分read-only字段和常规字段，read-only字段通常对应用户不能自己操作(添加或修改)
DRF 序列化器（Serializer）
m0_63969219的博客
06-10 1563
DRF 序列化器（Serializer）
drf-spectacular：用于Django REST框架的Sane和灵活的OpenAPI 3模式生成
02-04
- **Sane and Flexible**：`drf-spectacular`旨在提供一个理智且灵活的解决方案，自动检测并映射DRF视图、序列化器、验证器、模型等，同时允许自定义扩展，以满足特定需求。 - **自动检测**：自动扫描项目，识别...
drf-action-serializer：Django Rest框架的序列化器，支持字段的每个操作序列化
02-06
此外，`drf-action-serializer`还可以集成到DRF的视图和序列化器类中，使得整个API的逻辑更加模块化和易于维护。例如，你可以定义一个通用的序列化器类，并在其中定义各种字段操作，然后在具体的视图或模型序列化器...
Python编程实战课程：从小白到熟练掌握技能 五阶段 DRF框架第1天
03-25
DRF（Django Rest Framework）是一个基于Django的API开发框架，它可以让我们更容易地构建和维护RESTful API。 以下是一些基本的概念和步骤： 安装 DRF： 可以通过 pip install djangorestframework 命令进行安装 ...
drf_source:B站老男孩drf原始学习
03-23
2. **DRF基本使用**：学习如何安装DRF，配置项目，以及如何创建序列化器（Serializers）以转换数据模型为JSON或其他可序列化格式，以便于网络传输。 3. **视图与路由**：掌握DRF中的View和ViewSet概念，了解如何...
drf_tweaks：Django Rest Framework的扩展
02-04
1. **自定义序列化器行为** `drf_tweaks`允许开发者更轻松地自定义序列化器的行为，例如在序列化过程中增加额外的字段，或者改变默认的错误处理方式。这对于构建复杂API时处理多种数据格式非常有用。 2. **扩展...
【Django】网上蛋糕商城后台-商品管理
笔触狂放的博客
07-18 1298
选择某个商品，点击加入条幅，移除条幅，加入热销，移除热销，加入新品，移除新品按钮时，触发请求事件，传递不同参数信息给服务器。当管理员修改信息以及重新选择新图片后，将表单提交给服务器，服务器通过比较原图片以及新图片地址判断当前图片是否需要重新上传。当管理员填写完商品信息以及选择好上传的图片后，点击提交保存按钮，将表单提交给服务器。当管理员选择某个商品进行修改时，将该商品的商品编号以及所在分页页码发送给修改页面。当管理员选择某个商品删除的时候，触发请求。当管理员点击商品管理时，发送服务器请求。
Python Django功能强大的扩展库之channels使用详解
Rocky006的博客
07-23 1425
随着实时 web 应用程序的兴起，传统的同步 web 框架已经无法满足高并发和实时通信的需求。Django Channels 是 Django 的一个扩展，旨在将 Django 从一个同步 HTTP 框架转变为一个支持 WebSockets、HTTP2 和其他协议的异步框架。它不仅能够处理传统的 HTTP 请求，还可以处理 WebSockets 等长连接，使得 Django 开发者能够更轻松地构建实时 web 应用。本文将详细介绍 Django Channels 库，包括其安装方法、主要特性、基本和高级功能
26.8 Django多表操作
清风
07-25 1070
1.1 关系分类 1.2 外键字段 1.3 级联设置 2. 模型创建 2.1 子表和主表的概念 2.2 数据库与日志配置 2.4 一对多关系 2.5.1 自动创建关联表 2.5.2 手动动创建关联表 2.6 db_constraint 参数 2.7 db_table参数 3.2 测试模型创建
快醒醒，别睡了!...讲《数据分析pandas库》了—/—＜4＞
最新发布
qq_64603703的博客
07-27 717
详细解说数据分析pandas库中的常用方法
Django Rest Framework 中文教程：序列化与API开发
教程涵盖了序列化、请求与响应、基于视图的类、授权与权限、关系与超链接以及视图集与路由等多个核心概念。翻译者是Eason Smith，使用的Django版本为1.9.0，Django Rest Framework版本为3.3.2。教程建议在开始前准备...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

SteveRocket

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值