DRF - RESTful规范、DRF介绍与接口使用

目录

• 一、RESTful规范
  • 1.简介
  • 2.RESTful内容-10个规范
• 二、序列化与反序列化
  • 1.序列化
  • 2.反序列化
• 三、DRF介绍与快速使用
  • 1.DRF简介
  • 2.安装DRF
  • 3.基于Django原生编写5个接口
  • 4.DRF写接口案例

一、RESTful规范

1.简介

REST全称是Representational State Transfer，中文意思为表征性状态转移。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。

它与语言、平台无关，任何框架都可以写出符合RESTful规范的API接口

2.RESTful内容-10个规范

（1）数据的安全保障，通常使用https(http+ssl/tsl)协议来部署

• url链接一般都采用https协议进行传输
• 采用https协议，可以提高数据交互过程中的安全性

（2）接口中带api标识

https://api.lqz.com/books
https://www.lqz.com/api/books -多用这个

（3）多版本共存，路径当中带版本信息

https://api.lqz.com/v1/login
https://www.lqz.com/api/v2/login

（4）数据即是资源，均用名词(最核心的)

• 接口一般都是完成后台数据的交互，交互的数据我们称之为资源
• 接口形式如下

 https://api.baidu.com/users
https://api.baidu.com/books

• 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义

https://api.baidu.com/login

（5）资源操作由请求方式决定method

• 操作资源一般都会设计到增删改查，我们提供请求方式来标识增删改查动作

POST请求：添加数据
--> http://www.renran.cn/api/students/
 
GET请求：获取数据 
--> http://www.renran.cn/api/students/
 
DELETE：删除编号为pk的数据
--> http://www.renran.cn/api/students/<pk>/
 
PUT：修改编号为pk的全部信息，如[id,name,age]
--> http://www.renran.cn/api/students/<pk>/
 
PATCH：修改某个数据的部分信息,如[age]
--> http://www.renran.cn/api/students/<pk>/

（6）在请求地址中带过滤条件

https://api.baidu.com/books?name=红&price=99

（7）响应状态码：两套-一套http，一套公司自己规定的

• http响应状态码：

  • 1xx：请求正在处理
  • 2xx：成功响应
  • 3xx：重定向
  • 4xx：客户端错误
  • 5xx：服务端错误

• 公司内部规定的响应状态码，放在响应体中

  咱们后期一般使用100、101、102这种

{code:0}   
{status:0}

（8）返回数据中带错误信息

 {
  code:0
  msg: "ok/用户名错误"
 }

（9）返回的结果应该符合以下规范

• GET 获取所有数据：返回资源对象的列表（数组）

[{name:红楼梦，price：99}，{name:红楼梦，price：99}，{name:红楼梦，price：99}]

• GET 单个对象：返回单个资源对象：

{name:红楼梦，price：99}   

• POST 新增对象：返回新生成的资源对象：

{name:西游记，price：99}

• PUT 修改对象：返回完整的资源对象 ：

{name:西游记，price：100}

• DELETE 删除：

  返回一个空文档

（10）响应数据中带链接

二、序列化与反序列化

api接口开发，最核心常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分成两个阶段：

1.序列化

序列化： 把我们识别的数据转换成指定的格式提供给别人。

• 字典，列表：json格式存到文件中

• 例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。

• read

2.反序列化

反序列化：把别人提供的数据转换/还原成我们需要的格式。

• 例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。

• write

三、DRF介绍与快速使用

1.DRF简介

django-rest-framework：DRF，是Django的一个app，可以更快地在Django框架上编写接口

2.安装DRF

由于DRF默认Django版本低于3.X以下的会重新安装Django至最新版本，所以安装DRF后需要再次安装指定Django版本

pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/

-指定安装django 2.2.2版本

pip3 install django==2.2.2 -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com

3.基于Django原生编写5个接口

class BookView(View):
    # 一、查询所有图书
    def get(self, request):
        # 1 查询所有图书，得到的是queryset对象，不能直接给前端
        books = Book.objects.all()
        # 2 需要转换成json格式给前端
        # 3 把queryset对象转成列表，然后再使用JsonResponse
        book_list = []
        for book in books:
            book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})
 
        return JsonResponse(book_list, safe=False, json_dumps_params={'ensure_ascii': False})
 
    # 二、新增一个(只能用urlencoded或者form-data编码，使用json编码不行，因为json编码提交的数据，不能从request.POST中获得，只能从body中获得)
    def post(self, request):
        # 1 取出前端传入的数据
        name = request.POST.get('name')
        price = request.POST.get('price')
        publish = request.POST.get('publish')
        # 2 保存到数据库中
        book = Book.objects.create(name=name, price=price, publish=publish)
        # 3 返回新增的字典对象
        return JsonResponse({'name': book.name, 'price': book.price, 'publish': book.publish})
 
 
class BookDetailView(View):
    # 三、获取单条
    def get(self, request, pk):
        # 1 通过路由中的主键值获取数据
        book = Book.objects.filter(pk=pk).first()
        # 2 book模型对象转成字典，使用JsonResponse返回
        return JsonResponse({'id': book.id, 'name': book.name, 'price': book.price, 'publish': book.publish})
 
    # 四、修改数据
    def put(self, request, pk):  # request.POST只能取post提交的urlencoded或form-data编码数据，put提交的取不到
        print(request.body)
        # 1 查找需要修改的数据
        book = Book.objects.filter(pk=pk).first()
        # 2 由于前端使用json格式提交，需要我们操作 request.body 反序列化后，再自己保存数据
        book_dict = json.loads(request.body)
        book.name = book_dict.get('name')
        book.price = book_dict.get('price')
        book.publish = book_dict.get('publish')
        book.save()
 
        return JsonResponse({'id': book.id, 'name': book.name, 'price': book.price, 'publish': book.publish})
 
    # 五、删除数据
    def delete(self, request, pk):
        # 1 删除对应数据
        Book.objects.filter(pk=pk).delete()
        # 2 更具RESTful规范返回空文档
        return JsonResponse(data={})
 

（1）GET查询所有数据

（2）GET查询单个数据

（3）POST请求新增数据

（4）PUT请求修改数据


（5）DELETE请求删除数据

4.DRF写接口案例

# 使用drf编写5个接口（听个响）
 
# views中
from .serializer import BookSerializer
from rest_framework.viewsets import ModelViewSet
class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
 
# serializer
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'
        
# urls中
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
router.register('books', views.BookView, 'books')
 
urlpatterns = [
    path('admin/', admin.site.urls),
]
# 两个列表相加  [1,2,4] +  [6,7,8]=
urlpatterns += router.urls