restful规范(重要)
概念：
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。
十个规范：
-1 数据的安全保障，通常使用https（http+ssl/tsl）协议
-url链接一般都采用https协议进行传输
-采用https协议，可以提高数据交互过程中的安全性
-2 接口中带api标识
-https://api.lqz.com/books（可以写在域名中）
-https://www.lqz.com/api/books（也可以写在路由中） 咱们用这个
-3 多版本共存，路径中带版本信息
-https://api.weibo.com/2/
-https://api.weibo.com/v2/
-https://api.weibo.com/?version=2
-https://api.weibo.com/v1/login --->需要的参数name和pwd
-https://api.weibo.com/v2/login --->需要的参数name和pwd和code
-4 数据即是资源，均使用名词，尽量不出现动词(最核心的)
-接口一般都是用于完成前后台数据的交互，交互的数据我们称之为资源
-接口形式如下
https://api.baidu.com/users
https://api.baidu.com/books
-特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义、 https://api.baidu.com/get_user
-5 资源操作由请求方式决定（method）
-操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
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的书（局部修改一条）
'ps：patch用的不多，一般用put即可'
https://api.baidu.com/books/1 - delete请求：删除主键为1的书（删除一条）
-6 在请求地址中带过滤条件
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：指定筛选条件
-7 响应中状态码：两套
-http响应状态码：1xx：请求正在处理，2xx：成功响应，3xx：重定向，4xx：客户端错误，5xx：服务端错误
'常见的需要记住'
响应状态码2XX 200:常规请求 201:创建成功
响应状态码3XX 301:永久重定向 302:暂时重定向
响应状态码4XX 403:请求无权限 404:请求路径不存在 405:请求方法不存在
响应状态码5XX 500:服务器异常
-https://blog.csdn.net/li_chunlong/article/details/120787872
-公司内部规定的响应状态码，放在响应体中
{code:0} 咱们后期一般使用100 101 102这种
-8 返回数据中带错误信息
{
code:100
msg: 成功
}
"Message": "send success"
-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 响应数据中带连接
"url": "http://blog.sina.com.cn/zaku",
# Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
{
"status": 0,
"msg": "ok",
"results":[
{
"name":"肯德基(罗餐厅)",
"img": "https://image.baidu.com/kfc/001.png"
}
...
]
}
比较好的接口返回
# 响应数据要有状态码、状态信息以及数据本身
{
"status": 0,
"msg": "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"
}
...
]
}
序列化与反序列化
api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把【数据转换格式】，序列化可以分两个阶段：
序列化： 把我们识别的数据转换成指定的格式提供给别人
# 序列化： 把我们能识别的数据结构(python的字典，列表，对象)---》转换成其他语言(程序)能识别的数据结构
-python的字典，列表，对象-----》json格式字符串（可以是别的格式）
-前后端交互，目前通常使用 json格式字符串交互
-前后端分离模式中：主要指的是
-前端发送请求获取数据---》后端去数据库查询---》QuerySet对象---》转成json格式字符串---》返回给前端这个过程，称之为序列化
反序列化：把别人提供的数据转换/还原成我们需要的格式。
# 反序列化：把其他程序(语言)给我们的数据---》转换成我们能识别的数据结构
-前端给我们json格式数据 ---》转换成 字典，列表，对象
-前端给 name=lqz&age=19 格式数据 ---》转换成 字典，列表，对象
-前后端分离模式中：主要指的是
-前端携带json格式数据到后端----》后端拿到json格式数据---》把数据转成对象保存到数据库这个过程，咱们称之为反序列化
基于django原生编写5个接口
# 以后写的接口，基本上都是5个接口及其变形
-查询所有
-查询单个
-新增一个
-修改一个
-删除一个
# 基于books单表为例，写5个接口
-创建book表
-表迁移
-录入假数据：直接录，后台管理录
-写查询所有接口---》遵循restful规范，使用cbv
-新增一个数据---》
-查询一个
-修改一个：put提交的数据，不能从requets.POST中取
-删除一个
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)
urls.py
urlpatterns = [
path('admin/', admin.site.urls),
path('api/v1/books/', views.BookView.as_view()),
path('api/v1/books/<int:pk>', views.BookDetailView.as_view()),
]
views.py
from django.shortcuts import render, HttpResponse
from django.http import JsonResponse
from .models import Book
from django.views import View
import json
class BookView(View):
# 查询所有
def get(self, request):
# 查询出所有图书,queryset对象，不能直接给前端
books = Book.objects.all()
# 转成json格式，给前端
# 把queryset对象转成列表，然后再使用JsonResponse
book_list = []
for book in books:
book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})
# 拓展做了解
# return HttpResponse(json.dumps(book_list,ensure_ascii=False)) # 指定ensure_ascii为false，前端就显示中文了
return JsonResponse(book_list, safe=False, json_dumps_params={'ensure_ascii': False}) # JsonResponse只能放字典或列表
# 新增一个(只能使用urlencoded或form-data编码，使用json形式编码不行，因为json格式编码提交的数据，不能从request.POST中取，从body中)
def post(self, request):
# 取出前端传入的数据
name = request.POST.get('name')
price = request.POST.get('price')
publish = request.POST.get('publish')
# 存到数据库中
book = Book.objects.create(name=name, price=price, publish=publish)
# 返回新增的对象字典
return JsonResponse({'name': book.name, 'price': book.price, 'publish': book.publish})
class BookDetailView(View):
# 获取单条
def get(self, request, pk):
book = Book.objects.filter(pk=pk).first()
# 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提交的取不到
# 查到要改的
book = Book.objects.filter(pk=pk).first()
# 取出前端传入的数据，修改完，保存-----》存在问题，因为put提交的取不到
# book.name = request.POST.get('name')
# book.price = request.POST.get('price')
# book.publish = request.POST.get('publish')
# book.save()
# 前端使用json格式提交，自己保存
print(request.body)
book_dic=json.loads(request.body)
book.name = book_dic.get('name')
book.price = book_dic.get('price')
book.publish = book_dic.get('publish')
book.save()
return JsonResponse({'id': book.id, 'name': book.name, 'price': book.price, 'publish': book.publish})
def delete(self, request, pk):
Book.objects.filter(pk=pk).delete()
return JsonResponse(data={})
drf介绍和快速使用
概念
核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
官方文档：https://www.django-rest-framework.org/
github: https://github.com/encode/django-rest-framework/tree/master
特点（了解一下）
- 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
- 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
- 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
- 多种身份认证和权限认证方式的支持；[jwt]
- 内置了限流系统；
- 直观的 API web 界面；
- 可扩展性，插件丰富
安装
# djangorestframework: drf 帮助我们快速的实现符合restful规范的接口
# django 最新 4.x ，一般都会用最新版的上一版3.x
# drf最新支持到djagno 3.x ，最新不支持2.x
# 安装drf
pip3 install djangorestframework
# 如果你是django2.x 它发现它不支持，它会自动卸载dajgno，安装最新的django 4.x
pip3 install djangorestframework --upgrade 此命令会自动下载drf最新版本
如果想使用drf最新版和 django2.x
可使用以下办法
1.先执行 pip3 install djangorestframework装最新django
2.再执行 pip3 install django==2.2.2 这样就会把最新的django卸掉装django2.2.2 但是后续会有其他问题比如第三方模块不兼容和
以后工作中，可能会遇到第三方模块跟python版本不兼容，
代码
ps:url的末尾必须要写斜杠符号，不然会报错
# 使用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
'''
获取所有图书：Get http://127.0.0.1:8000/books/
获取单个图书：Get http://127.0.0.1:8000/books/1/ 加上ID号
新增数据： POST http://127.0.0.1:8000/books/ Body内写入数据
删除数据： DeLETE http://127.0.0.1:8000/books/1/ 加上ID号
修改数据： PUT http://127.0.0.1:8000/books/2/?name=你问我为什么&price=999&publish=在家出版社
就是这么简单快速 五个接口就立马写好了 这是DRF的速度
'''
cbv源码分析
#1 请求来了---》执行 ---》views.BookView.as_view()(request)--->执行View类中as_view类方法中得 闭包函数 view
@classonlymethod
def as_view(cls, **initkwargs):
def view(request, *args, **kwargs):
self = cls(**initkwargs) # BookView类实例化得到对象
self.dispatch(request, *args, **kwargs) # BookView类的dispatch
# 2 BookView类的dispatch没有---》View的dispatch
# 根据请求方式，通过反射去视图类中【BookView】反射出跟请求方式同名的方法，执行
def dispatch(self, request, *args, **kwargs):
if request.method.lower() in self.http_method_names:
handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
return handler(request, *args, **kwargs)
# 3 以什么请求方式访问---》就会执行视图类中 跟请求方式同名的方法
比如：http://127.0.0.1:8000/books/ get请求
执行BookView类中get方法
APIView执行流程源码分析(了解)
# 以后使用drf写符合restful规范的接口---》都继承 APIView
# 小案例：继承 APIView 写5个接口
### 注意：
1 / 严格
2 删除了id为1的记录---》判断查询结果有没有，再序列化
### #### 继承APIView+Response和django原生View区别到底在哪？####
-记住（drf是个app）：要在app中 注册app，rest_framework，注册后
-在浏览器中访问：drf好看的样子（必须要注册）
-在postman中访问：纯json
如何快速定位源码
path('books/', views.BookView.as_view()),
# 1 请求来了---》会执行views.BookView.as_view()(request) ---》找as_view---》BookView找不到---》APIView中找---》as_view--->就干了一个事--》去除了csrf认证
@classmethod
def as_view(cls, **initkwargs):
view = super().as_view(**initkwargs) # 调用父类---》django原生View的as_view
view=csrf_exempt(view)
# 等同于
'''
@csrf_exempt
def view:
pass
'''
return view # 当前请求，去除掉了csrf认证
# 2 views.BookView.as_view()(request) 本质是执行 csrf_exempt(view)(request)
-执行View的 中as_view内的view函数--》去除了csrf认证
# 3 本质在执行：self.dispatch(request, *args, **kwargs)
BookView的dispatch---》BookView没有---》APIView找---》找到了
def dispatch(self, request, *args, **kwargs):
# 包装新的request
request = self.initialize_request(request, *args, **kwargs)
try:
# 执行三大认证
self.initial(request, *args, **kwargs)
# 执行跟请求方式同名的视图类中得方法
if request.method.lower() in self.http_method_names:
handler = getattr(self, request.method.lower(),
self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
response = handler(request, *args, **kwargs)
except Exception as exc:
# 处理了全局异常
response = self.handle_exception(exc)
self.response = self.finalize_response(request, response, *args, **kwargs)
return self.response
# 总结：
1 APIView执行流程---》去除csrf--》执行了APIView的dispatch
2 执行的as_view是APIView的as_view
3 执行的dispatch也是APIView的dispatch
去除局部csrf认证
from django.views.decorators.csrf import csrf_exempt
@csrf_exempt #本质 index= csrf_exempt(index) #加个内置装饰器
def index(request):
return render(request,'index.html')
1 继承APIView后，所有视图类，都没有csrf认证了，我们也不需要注释全局中间件了
1 csrf_exempt(view) ---》
2 装饰器
前端补充
# 混合项目，基于别人的写
-copy 别的html页面，加模板语法
# 老一些的
jq，bootstrap3：后台管理：hplus4.1-master.zip
layui：类似于bootstrap 官网http://layui.apixx.net/
基于layui的后台管理：X-admin-master.zip
# 新一些的
-bootstrap5和jq写的 bootstrap-admin-V2.0.1.zip
-http://lyear.itshubao.com/lyear_ui_buttons.html