drf入门——web应用模式、api接口、postman
drf入门——web应用模式、api接口、postman
目录
web应用模式
在开发web应用中，有两种应用模式：
1.前后端不分离
客户端看到的内容和所有界面效果都是由服务端提供的。
2.前后端分离
把前端的界面效果（HTML、CSS、JS）分离到另一个服务端，python服务端只需要返回数据。前端形成一个独立的网站，服务端构成一个独立的网站。
api接口
API(Application Programming Interface,应用程序编程接口)
为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口用途一目了然，减少双方(前后端)之间的合作成本。
api接口：前后端交互的媒介
通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介。
# Web API接口简单概括有下面四大特点:
url：长得像返回数据的url链接
https://api.map.baidu.com/place/v2/search
请求方式：get、post、put、patch、delete
采用get方式请求上方接口
请求参数：json或xml格式的key-value类型数据
-早些年，前后端交互使用xml格式----》ajax：异步JavaScript和XML
-后来，随着json格式的出现且成了主流，直到现在
-以后：一定会出现，比json更高效、更安全的交互格式
ak：6E823f587c95f0148c19993539b99295
region：上海
query：肯德基
output：json
响应结果：json或xml格式的数据
上方请求参数的output参数值决定了响应数据的格式
# xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%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®ion=%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
作为后端写好接口了，需要测试通过后再给别人使用。
而写的接口需要有工具测试，浏览器只能发送get请求，不能自动发送post，delete请求。所以可使用postman进行接口的测试工作。
# postman的使用
-1 官方下载：
https://www.postman.com/downloads/?utm_source=postman-home
软件：Postman-win64-Setup.exe
-2 安装，双击即可
postman操作介绍
restful规范
REST全称是Representational State Transfer,中文意思是：表征性状态转移，他首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
# 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）
-操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
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 - delete请求：删除主键为1的书
6、在请求地址中带过滤条件 https://api.baidu.com/books?name=红&price=99
7、响应中状态码：两套
-http响应状态码：
1xx：请求正在处理;
2xx：成功响应;
3xx：重定向;
4xx：客户端错误;
5xx：服务端错误
-https://blog.csdn.net/li_chunlong/article/details/120787872
-公司内部规定的响应状态码，放在响应体中
{code:0} 咱们后期一般使用100 101 102这种
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接口开发：
最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：
# 序列化： 把我们识别的数据转换成指定的格式提供给别人
-字典，列表------》json格式存到文件中了
-例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人
-read
# 反序列化：把别人提供的数据转换/还原成我们需要的格式。
-例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
-write
基于django原生编写5个接口
# 以后写的接口，基本上都是5个接口及其变形（views）
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):
# 查询所有图书
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只能放字典或列表
-查询单个
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})
-新增一个
# 新增一个(只能使用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})
-修改一个
def put(self, request, pk):
# request.POST只能取post提交的urlencoded或form-data编码数据，put提交的取不到
# 查到要改的
book = Book.objects.filter(pk=pk).first()
# 取出前端传入的数据，修改完保存（存在问题，put提交的数据取不到）
# 解决办法——前端使用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 = Book.objects.filter(pk=pk).delete()
return JsonResponse(data={})
# 模板层创建book表(models)
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,遵循restful规范，使用cbv)
from django.contrib import admin
from django.urls import path, re_path
from app01 import views
urlpatterns = [
path('admin/', admin.site.urls),
path('api/v1/books', views.BookView.as_view()),
path('api/v1/books/<int:pk>', views.BookDetailView.as_view()),
# re_path('api/v1/books/(?P<pk>\d+)',views.BookDetailView.as_view()),
# re_path，正则匹配范围太大
]
drf介绍和快速使用
# djangorestframework: drf 帮助我们快速的实现符合restful规范的接口
# 安装drf
pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/
# 使用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
cbv源码分析
#视图层(views)
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')
<!-- 模板层 -->
<form action="/cbv/" method="post">
{% csrf_token %}
<input type="text" name="usr">
<button type="submit">提交</button>
</form>
# 路由层(urls)
from app import views
urlpatterns = [
url(r'^cbv/', views.CBVTest.as_view()),
]
