Django REST framework的使用简单介绍

最新推荐文章于 2023-01-12 08:00:00 发布
最新推荐文章于 2023-01-12 08:00:00 发布
阅读量243 收藏
点赞数
文章标签： python 数据库 前端 ViewUI
原文链接：http://www.cnblogs.com/LiuXinyu12378/p/11247073.html
版权

 

                                                                           　　　　　　　　　　　　　　　　　　　　　　　　　　　　

 

官方文档：https://www.django-rest-framework.org/

GitHub源码：https://github.com/encode/django-rest-framework/tree/master

 

1. 安装DRF

pip install djangorestframework

　　

2. 添加rest_framework应用

我们利用在Django框架学习中创建的demo工程，在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

　　

接下来就可以使用DRF进行开发了。

 

定义Serializer

1. 定义方法

Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。

例如，我们已有了一个数据库模型类BookInfo

class BookInfo(models.Model):
    btitle = models.CharField(max_length=20, verbose_name='名称')
    bpub_date = models.DateField(verbose_name='发布日期', null=True)
    bread = models.IntegerField(default=0, verbose_name='阅读量')
    bcomment = models.IntegerField(default=0, verbose_name='评论量')
    image = models.ImageField(upload_to='booktest', verbose_name='图片', null=True)

　　

我们想为这个模型类提供一个序列化器，可以定义如下：

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名称', max_length=20)
    bpub_date = serializers.DateField(label='发布日期', required=False)
    bread = serializers.IntegerField(label='阅读量', required=False)
    bcomment = serializers.IntegerField(label='评论量', required=False)
    image = serializers.ImageField(label='图片', required=False)

　　

注意：serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。

 

2. 字段与选项

常用字段类型：

字段字段构造方式
BooleanFieldBooleanField()
NullBooleanFieldNullBooleanField()
CharFieldCharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailFieldEmailField(max_length=None, min_length=None, allow_blank=False)
RegexFieldRegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugFieldSlugField(maxlength=50, min_length=None, allow_blank=False) 
正则字段，验证正则模式 [a-zA-Z0-9-]+
URLFieldURLField(max_length=200, min_length=None, allow_blank=False)
UUIDFieldUUIDField(format='hex_verbose') 
format: 
1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 
2） 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 
3）'int' - 如: "123456789012312313134124512351145145114" 
4）'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"
IPAddressFieldIPAddressField(protocol='both', unpack_ipv4=False, **options)
IntegerFieldIntegerField(max_value=None, min_value=None)
FloatFieldFloatField(max_value=None, min_value=None)
DecimalFieldDecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None)
max_digits: 最多位数
decimal_palces: 小数点位置
DateTimeFieldDateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateFieldDateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeFieldTimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationFieldDurationField()
ChoiceFieldChoiceField(choices)
choices与Django的用法相同
MultipleChoiceFieldMultipleChoiceField(choices)
FileFieldFileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageFieldImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListFieldListField(child=<a_field_instance>, min_length=None, max_length=None)
DictFieldDictField(child=<a_field_instance>)

选项参数：

 

参数名称作用
max_length最大长度
min_lenght最小长度
allow_blank是否允许为空
trim_whitespace是否截断空白字符
max_value最小值
min_value最大值

 

通用参数：
参数名称说明
read_only表明该字段仅用于序列化输出，默认False
write_only表明该字段仅用于反序列化输入，默认False
required表明该字段在反序列化时必须输入，默认True
default反序列化时使用的默认值
allow_null表明该字段是否允许传入None，默认False
validators该字段使用的验证器
error_messages包含错误编号与错误信息的字典
label用于HTML展示API页面时，显示的字段名称
help_text用于HTML展示API页面时，显示的字段帮助提示信息

 序列化的使用

1.基本使用

对一个图书对象进行序列化

from booktest.models import BookInfo
from booktest.serializers import BookInfoSerializer
book = BookInfo.objects.get(id=2)
serializer = BookInfoSerializer(book)

serializer.data
# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}

　对多个图书对象进行序列化，注意需要加参数many=True

from booktest.models import BookInfo
from booktest.serializers import BookInfoSerializer
book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data
# [OrderedDict([('id', 2), ('btitle', '天龙八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]

　　

2 关联对象嵌套序列化（在有外键的时候使用）

1） PrimaryKeyRelatedField

此字段将被序列化为关联对象的主键。

hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)

　　

2) StringRelatedField

此字段将被序列化为关联对象的字符串表示方式（即__str__方法的返回值）

hbook = serializers.StringRelatedField(label='图书')

　　

3）使用关联对象的序列化器
hbook = BookInfoSerializer()

　　

反序列化使用

使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。

在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。

验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。

验证成功，可以通过序列化器对象的validated_data属性获取数据。

 

from booktest.serializers import BookInfoSerializer
data = {'bpub_date': 123}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # 返回False
serializer.errors
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data  # {}

data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.errors  # {}
serializer.validated_data  #  OrderedDict([('btitle', 'python')])

　　

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError，可以通过传递raise_exception=True参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。

# Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)

　　

 

 

转载于:https://www.cnblogs.com/LiuXinyu12378/p/11247073.html

agrj56057
关注
django rest framework
yx1179109710的博客
08-11 463
先安装djangorestframework：     pip install djangorestframework 建立模型：models.py from django.db import models # Create your models here. class Grade(models.Model): name = models.CharField(max...
django rest framework 自定义返回方式
09-16
本文将详细介绍如何在Django REST Framework中自定义返回方式。 首先，我们需要创建一个新的Response子类来扩展默认的响应功能。这里我们定义了一个名为JsonResponse的类，它继承自rest_framework.response....
Django Rest Framework
weixin_30877755的博客
11-20 105
一、什么是Restful REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移” REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态 所有的数据，不过是通过网络获取的还是操作（增删改查）...
Django REST framework
郭帅的博客
08-05 4350
  Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。 通常简称为DRF框架 或 REST framework。 特点 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化； 提供了丰富的类视图、Mixin扩展类，简化视图的编写； 丰富的定制层级：函数视图、类视图、视图集合...
Django REST framework讲义PDF全集，中文文档PDF版
08-11
Django REST Framework（DRF）是基于Python的Django Web框架的一个强大扩展，专为构建Web API而设计。本讲义全面涵盖了这个框架的核心概念、功能以及最佳实践，旨在帮助开发者快速掌握如何利用DRF创建高效、可维护的...
Vue+Django REST framework 打造生鲜电商项目.docx
09-26
Vue 和 Django REST framework 是当前非常流行的前端和后端技术栈，本文档旨在指导读者使用 Vue 和 Django REST framework 联合开发一个完整的生鲜电商项目。 1. 项目概述 本项目的目标是使用 Vue 作为前端框架，...
重写 Django REST framework drf-api-logger 应用
最新发布
06-29
在Django REST Framework（DRF）中，`drf-api-logger`是一个非常有用的库，它可以帮助开发者记录API请求的日志，以便于监控、调试和分析应用的行为。然而，原始的`drf-api-logger`可能并不完全满足所有需求，比如在...
django restframework
似水灬流年的博客
02-18 221
1.POST请求免于csrf认证 from django.views.decorators.csrf import csrf_exempt @csrf_exempt 写入被修饰的函数 2.POST请求仅要求此函数要通过csrf认证 from django.views.decorators.csrf import csrf_protect @csrf_...
Django-rest framework
小玖工作坊-博客
12-30 504
Django-rest Framework 1. FBV CBV 1.1 开发模式 普通开发方式（前后端放在一起写） 前后端分离 1.2 后端开发 为前端提供URL（API/接口的开发） 注：永远返回HttpResponse 1.3 Django FBV、CBV # FBV(function base view) def users(request): user_list = ['alex','oldboy'] return HttpResponse(json.dumps((user_
​ 一：drf --drf入门规范
wmyzzz
11-02 1370
目录一：web开发模式1.1 前后端不分离1.2 前后端分离二：API接口三：接口测试工具：Postman四：RESTful API规范restful十条规范1 数据的安全保障2 接口特征表现3 多数据版本共存4 （重点）数据即是资源，均使用名词（可复数）5 （重点）资源操作由请求方式决定（method）过滤，通过在url上传参的形式传递搜索条件7 响应状态码7.1 正常响应7.2 重定向响应7.3 客户端异常7.4 服务器异常8 错误处理，应返回错误信息，error当做key9 返回结果，针对不同操作，服
Rest Framework设计规范
程序编程之旅
10-24 262
Rest Framework是前后端分离中用到的一种规范，它与框架本身无关，是一种软件架构风格，全称为Representational State Transfer。　　Rest F...
Django REST framework框架
wuyepiaoxue789的博客
06-14 403
在此案例中，前后端均发送JSON格式数据。 urls.py 1、REST接口开发的核心任务在开发REST API接口时，视图中做的最主要的三件事：将请求的数据（如JSON格式）转换为模型类对象 操作数据库 将模型类对象转换为响应的数据（如JSON格式）2、序列化 Serialization我们可以将序列化；理解为：将程序中的一个数据结构类型转换为其他格式（字典、JSON、XML等），例如将Django中的模型类对象转换为JSON字符串，这个转换过程我们称为序列化。如： 反之，将其他格式（字典
django-rest-framework的使用
max_LLL的博客
01-20 5577
同步更新于个人博客系统：django-rest-framework的使用 同步更新于个人博客系统：django-rest-framework的使用 同步更新于个人博客系统：django-rest-framework的使用 RESTFUL 在学习这个第三方库之前，我们需要了解什么是restful！度娘给的解释如下： RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调
django rest framework快速使用
fggdgh的博客
08-20 330
djang rest framework快速开始
django rest_framework的简单使用
weixin_42935779的博客
10-23 305
Django版本：django 2.0 python版本：python 3.6 首先新建一个Django项目，例如我创建的项目名称是：djangoRestful 接着新建一个app，我新建的app叫：restful 修改settings.py: INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', ...
Django（16）：rest_framework框架使用指南
qq_43745578的博客
01-12 3761
rest_framework框架使用总结
Django Rest Framework JWT 使用详解与原理剖析
"本文主要讲解了Django Rest Framework中JWT（JSON Web Token）的使用方法，包括JWT的基本概念、组成部分以及在Django REST框架下的实际应用。" 在Django Rest Framework中，JWT常用于实现安全的身份验证和授权，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值