0801 RESTAPI设计，DRF 序列化

1.内容回顾
    1.restframework serializer(序列化)的简单使用
        
        QuereySet([obj,obj,obj])  -->  JSON格式数据
        
    安装和导入：
        pip install djangorestframework
        
        from rest_framework import serializer
        
        1.创建一个类，类一定要继承serializer.Serializers
        
        2.chocie字段和FK字段都可以通过source来获取对应的值
        
        3.多对多字段可以通过使用serializer.SerializerMethod
    
                声明序列化器：
                def get_tag(self, obj):
                    tag_list = []
                    for i in obj.tag.all():
                        tag_list.append(i.name)
                    return tag_list
                    
        2.使用 ModelSerializer
        
            通过配置class Meta:
                        model = 表名
                        fields = [‘字段‘, ...]
                        depth = 1
                        
2. 今日内容
    1. RESTful风格API介绍

一、什么是RESTful
REST -- REpresentational State Transfer，英语的直译就是“表现层状态转移”。如果看这个概念，估计没几个人能明白是什么意思。那下面就让我来用一句人话解释一下什么是RESTful:URL定位资源，用HTTP动词（GET,POST,PUT,DELETE)描述操作。

Resource：资源，即数据。
Representational：某种表现形式，比如用JSON，XML，JPEG等；
State Transfer：状态变化。通过HTTP动词实现。

REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”。

REST从资源得角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态。

所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性。

二、RESTful API设计

API与用户的通信协议

总是使用HTTPs协议。

域名

https://api.example.com        尽量将API部署在专用域名

https://example.org/api/       API很简单

版本

1.  将版本信息放在URL中，如：https://api.example.com/v1/

2. 将版本信息放在请求头中。

路径

视网络上任何东西都是资源，均使用名词表示（可复数）

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

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

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

method

GET      ：从服务器取出资源（一项或多项）

POST    ：在服务器新建一个资源

PUT      ：在服务器更新资源（客户端提供改变后的完整资源）

PATCH  ：在服务器更新资源（客户端提供改变的属性）

DELETE ：从服务器删除资源

过滤

通过在url上传参的形式传递搜索条件

https://api.example.com/v1/zoos?limit=10：指定返回记录的数量

https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置

https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数

https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序

https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件



状态码




200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。




更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html




错误处理




状态码是4xx时，应返回错误信息，error当做key。　　　　





{
    error: "Invalid API key"
}





返回结果




针对不同操作，服务器向用户返回的结果应该符合以下规范




GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档




Hypermedia API




RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。




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


 


2. from rest_framework import APIView


　　 class Comment(views.View):
        　  pass

    --------  之前的写法 ↑  ----------

    class APIView(views.View)：
        扩展的功能
        self.request = Resquest(
            self._request = request(Django的request)
        )
        self.request.data  封装好的数据属性，POST\PUT请求携带的数据都可以从这里取
        pass

　　class Comment(APIView):
        pass


3. serializer
        1. ModelSerializer
            1. 基于APIView实现的GET和POST
            2. POST过来的数据进行校验
            3. 保存数据
        2. 超链接的URL



原文地址：https://www.cnblogs.com/Mr-Murray/p/9402305.html
				


				
时间： 2024-08-28 00:52:41 

		


		


	

	
	

		


		
0801 RESTAPI设计，DRF 序列化的相关文章


								

		

			

                drf序列化器与反序列化
			

		

		

									

				什么是序列化与反序列化 """ 序列化:对象转换为字符串用于传输 反序列化:字符串转换为对象用于使用 """ drf序列化与反序列化 """ 序列化:Model类对象转换为字符串用于传输 反序列化:字符串转换为Model类对象用于使用 """ Model类 创建数据库:终端 >: mysql -uroot -p密码 >: create database 数据库名 charse			

		

	

				

		

			

                DRF序列化代码
			

		

		

									

				DRF序列化 --- 要安装Djangorestframework --- 要使用的时候要在setting中注册app--rest_framework --- 使用之前要定义一个序列化器,指定要序列化的字段 下面 是models中的表: from django.db import models # Create your models here. __all__ = ['Book','Publisher','Auth'] class Book(models.Model): title = mod			

		

	

				

		

			

                drf 序列化模块03
			

		

		

									

				新建项目准备 import sys # 标准输出流 sys.stdout.write('123\n') sys.stdout.write('456\n') sys.stdout.write('sdkfhsd四大皆空分段函数\n') # 标准输入流 res = sys.stdin.readline() # 运行后在终端可输入内容以绿色显示 print(res) # 标准错误流 sys.stderr.write('abc') # 在终端以红色字体显示括号内的内容 sys.stderr.write('			

		

	

				

		

			

                DRF序列化器的使用
			

		

		

									

				序列化器的使用 序列化器的使用分两个阶段: 在客户端请求时,使用序列化器可以完成对数据的反序列化. 在服务器响应时,使用序列化器可以完成对数据的序列化. 序列化的基本使用 使用的还是上一篇博文中使用的数据库 先查询出一个学生对象 from students.models import Student student = Student.objects.get(id=3) 构造序列化器对象 from .serializers import StudentSerializer serializer			

		

	

				

		

			

                drf序列化器serializers.SerializerMethodField()的用法
			

		

		

									

				为什么DRF中有时候返回的json中图片是带域名的,有时候是不带域名的呢? 解析: 带域名的结果是在view中对模型类序列化的,DRF在序列化图片的时候 会检查上下文有没有request,如果有,就给图片加上域名, 比如说我们视图用的是apiview(): 我们需要序列化数据的时候,加  context={"request":request} TestSerilaizer(instance=instance, context={"request":request})			

		

	

				

		

			

                drf序列化器的实例
			

		

		

									

				应用目录结构: views.py from django.shortcuts import render # Create your views here. from django.views import View from django.http import JsonResponse, QueryDict from bookset.models import BookInfo #导入序列化列 from .serializers import BookInfoSerializer #####			

		

	

				

		

			

                【DRF序列化】
			

		

		

									

				目录 基本的序列化操作 外键/多对多关系的序列化 反序列化的操作 单条数据查询及更新 数据的校验 单个字段的校验 多个字段的校验 自定义校验器 终极用法 ModelSerializer "前后端分离后,其交互一般都选择使用JSON数据格式,JSON是一个轻量级的数据交互格式. 因此,后端发送给前端(或前端发送给后端)的数据都要转成JSON格式,这就得需要我们把从数据库内取到的数据进行序列化. 本文将详细讲述Django项目中如何使用第三方库rest_framework进行序列化. 在命令行中输入			

		

	

				

		

			

                drf  序列化  反序列化
			

		

		

									

				准备: 配置:settings.py INSTALLED_APPS = [ 'rest_framework', ] DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'dg_proj', 'USER': 'root', 'PASSWORD': '123', } } LANGUAGE_CODE = 'zh-hans' TIME_ZONE = 'Asia/Shanghai' USE_I18N = True			

		

	

				

		

			

                drf序列化与反序列化
			

		

		

									

				序列化器-Serializer 定义序列化器 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(