Django-rest-framework框架之drf入门规范

最新推荐文章于 2024-08-18 11:37:50 发布

皮糖小王子

最新推荐文章于 2024-08-18 11:37:50 发布

阅读量198

点赞数

分类专栏： drf框架文章标签： django restful 后端 postman

本文链接：https://blog.csdn.net/DiligentGG/article/details/127011581

版权

drf框架专栏收录该内容

9 篇文章 0 订阅

订阅专栏

博客内容概要

前后端开发模式
API接口
接口测试工具postman
restful规范
序列化和反序列化
djangorestframework快速使用
cbv源码分析

前后端开发模式

1.参考博客
https://www.cnblogs.com/liuqingzheng/p/10900502.html

补充：xadmin：前端的后台管理模板：layui+jquery
admin-lte：前端后台管理模板：bootstrap+jquery

2.Web应用模式

前后端混合开发----》模板，使用模板语法渲染模板
后端人员要通过前端写好的html页面，套模板语法。

前后端分离
后端人员只负责写接口（API接口），使用postman接口测试工具测试；
前端人员负责写前端，写的过程中使用mock数据；
最后前后端联调项目。

API接口

1.概念
通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介。

2.Web API接口简单概括有下面四大特点

url：长得像返回数据的url链接
https://api.map.baidu.com/place/v2/search
请求方式：get、post、put、patch、delete
采用get方式请求上方接口
请求参数：json或xml格式的key-value类型数据
ak：6E823f587c95f0148c19993539b99295
region：上海
query：肯德基
output：json
响应结果：json或xml格式的数据
响应结果：json或xml格式的数据

# xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
   "status":0,
 	"message":"ok",
   "results":[
       {
           "name":"肯德基(罗餐厅)",
           "location":{
               "lat":31.415354,
               "lng":121.357339
           },
           "address":"月罗路2380号",
           "province":"上海市",
           "city":"上海市",
           "area":"宝山区",
           "street_id":"339ed41ae1d6dc320a5cb37c",
           "telephone":"(021)56761006",
           "detail":1,
           "uid":"339ed41ae1d6dc320a5cb37c"
       }
     	...
		]
}

接口测试工具postman

1.使用前提
针对API接口写好后，后端人员要测试的话不能直接在浏览器里测试，所以需要用postman软件进行接口测试。
2.postman本质
其本质为模拟发送http请求。
官网下载：https://www.postman.com/downloads/

3.简易的get请求

4.简易的post请求

5.请求百度地图接口

restful规范

1.概念
REST全称是Representational State Transfer，中文意思是表述:表征性状态转移, 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

2.restful规范有10点

数据的安全保障：url链接一般都采用https协议进行传输 —>为了保证数据安全使用https协议传输
-https是什么：http+ssl/tsl
接口中带api关键词
https://api.baidu.com
https://www.baidu.com/api

注：看到api字眼，就代表该请求url链接是完成前后台数据交互的
多数据版本共存，一个接口可能有多个版本—》url链接中标识版本标识
假设咱们有个登录接口：开始只要用户名和密码后来用户名，密码，验证码
https://api.baidu.com/v1
https://api.baidu.com/v2

注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
数据即是资源，均使用名词（可用复数）—》接口尽量使用名词
都是用名词，没法区分是增加，删除，修改，查询
接口一般都是完成前后台数据的交互，交互的数据我们称之为资源

https://api.baidu.com/users
https://api.baidu.com/books
https://api.baidu.com/book
注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：>https://api.baidu.com/delete-user

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

https://api.baidu.com/place/search
https://api.baidu.com/login
资源操作由请求方式决定
https://api.baidu.com/books - get请求：获取所有书
https://api.baidu.com/books/1 - get请求：获取主键为1的书
https://api.baidu.com/books - post请求：新增一本书书
https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
https://api.baidu.com/books/1 - delete请求：删除主键为1的书
请求地址一样，通过请求方式决定对资源进行什么操作

url地址中带过滤参数
获取动物园所有动物 127.0.0.1/api/v1/animals —>get请求
获取动物园所有哺乳类动物 127.0.0.1/api/v1/animals?type=哺乳类 —>get请求
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：指定筛选条件
响应带状态码
http状态码：http://tools.jb51.net/table/http_status_code
(1)正常响应

响应状态码2xx
200：常规请求
201：创建成功

(2) 重定向响应

响应状态码3xx
301：永久重定向
302：暂时重定向

(3)客户端异常

响应状态码4xx
403：请求无权限
404：请求路径不存在
405：请求方法不存在

(4) 服务器异常

响应状态码5xx
500：服务器异常
返回错误信息—>响应体中带错误信息
{code:100,msg:成功}

错误处理，应返回错误信息，error当做key

{
   error: "无权限操作"
}
返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
GET /collection：返回资源对象的列表（数组）[{},{}]
GET /collection/resource：返回单个资源对象 {}
POST /collection：返回新生成的资源对象 {}
PUT /collection/resource：返回完整的资源对象 {}
PATCH /collection/resource：返回完整的资源对象 {}
DELETE /collection/resource：返回一个空文档
   -获取所有：{code:100,msg:成功,data:[{name:金瓶梅,price:99},{name:西游记,price:88}]}
   -获取单条：{code:100,msg:成功,data:{name:金瓶梅,price:99}}
   -新增数据：{code:100,msg:新增成功,data:{name:西游记,price:99}}
   -修改数据：{code:100,msg:修改成功,data:{name:西游记v2版本,price:99}}
   -删除数据：{code:100,msg:删除成功}    
响应中带链接
# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
{
 	"status": 0,
 	"msg": "ok",
 	"results":[
       {
           "name":"肯德基(罗餐厅)",
           "img": "https://image.baidu.com/kfc/001.png"
       }
     	...
		]
}

序列化和反序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：
1.序列化：
把我们识别的数据转换成指定的格式提供给别人。
例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。
==2.反序列化
把别人提供的数据转换/还原成我们需要的格式。
例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。

djangorestframework快速使用

使用django这个web框架，开发前后端分离项目(模板渲染),只写接口
-使用JsonResponse返回即可—》原生django
-djangorestframework方便咱们快速写出符合restful规范的接口

写接口：总共就5个及这5个的变形
-获取所有 get
-获取单个 get
-新增一条 post
-修改一条 put/patch
-删除一条 delete

对于book表，快速实现这5个接口—》不需要你会
-使用drf有多块
-安装drf：pip3 install djangorestframework

代码展示
urls.py

from django.contrib import admin
from django.urls import path
from rest_framework.routers import SimpleRouter
from app01 import views

router = SimpleRouter()
router.register('books', views.BookView)
urlpatterns = [
   path('admin/', admin.site.urls),
]
urlpatterns += router.urls

views.py

from .models import Book
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer


class BookView(ModelViewSet):
   queryset = Book.objects.all()
   serializer_class = BookSerializer

models.py

from django.db import models


class Book(models.Model):
   name = models.CharField(max_length=32)
   price = models.CharField(max_length=32)
   publish = models.CharField(max_length=32)

serializer.py

from rest_framework import serializers
from .models import Book


class BookSerializer(serializers.ModelSerializer):
   class Meta:
       model = Book
       fields = '__all__'

通过postman测试

cbv源码分析

1.视图层

from django.shortcuts import render, HttpResponse
from django.views import View
class CBVTest(View):
   # 通过调度(dispatch)分发请求
   def dispatch(self, request, *args, **kwargs):
       pass
       super().dispatch(request, *args, **kwargs)
       pass

   def get(self, request):
       return render(request, 'cbv.html')

   def post(self, request):
       return HttpResponse('cbv post method')

2.模板层

<form action="/cbv/" method="post">
   {% csrf_token %}
   <input type="text" name="usr">
   <button type="submit">提交</button>
</form>

3.路由层

from app import views
urlpatterns = [
   url(r'^cbv/', views.CBVTest.as_view()),
]

4.分析步骤
cbv写好后，路由配置如下：

第一个参数是路径，第二个参数是试图函数的内存地址（视图类执行as_view这个类方法，把它执行完，结果放在第二个参数上：我们猜执行完的结果是个函数内存地址）

path('test/', views.TestView.as_view()),

去找as_view，去TestView类中找，找不到，没有，去父类中找View

       @classonlymethod
       def as_view(cls, **initkwargs):
           def view(request, *args, **kwargs):
               return self.dispatch(request, *args, **kwargs)
           return view

当请求来了，路由匹配成功，会执行view(request)—>本质执行self.dispatch(request, *args, **kwargs)
去View中找到了dispatch

       def dispatch(self, request, *args, **kwargs):
           # 请求方式转成小写，假设 get 请求，符合if条件
           if request.method.lower() in self.http_method_names:
               # 反射 getattr(对象,'字符串','默认值')
               # self是TestView的对象
               # handler 就是TestView类的get方法
               handler = getattr(self, 'get', self.http_method_not_allowed)
           else:
               handler = self.http_method_not_allowed
           return handler(request, *args, **kwargs)  # get(request)