接口
接口:联系两个物质的媒介,完成信息交互 web程序中:联系前台页面与后台数据库的媒介 web接口组成: - url:长得像返回数据的url链接 - 请求参数:前台按照指定的key提供数据给后台 - 响应数据:后台与数据库交互后将数据反馈给前台
规范
web数据请求接口设计规范
# 分两部分 1. url: 1)通常使用https请求 2)域名:有api关键字出现 -- https://api.example.com (存在跨域问题) -- https://example.com/api 3)版本:不同版本需要标注 -- https://example.com/api/v1 | -- https://example.com/api/1 -- https://example.com/api/v2 | -- https://example.com/api/2 4)资源:请求的目标数据称之为资源,资源一般都有名词复数表示 -- https://example.com/api/v1/books (之前不规范的案例: /get_books/) 5)操作方式:不从请求链接体现操作方式,从请求方式上决定操作方式(一条url对应get或post等多种操作,所以后端采用CBV) -- get:https://example.com/api/v1/books 获取所有 -- post:https://example.com/api/v1/books 新增一本 -- put:https://example.com/api/v1/book/1 更新id=1的一本(整体更新) -- patch:https://example.com/api/v1/book/1 更新id=1的一本(局部更新) -- delete:https://example.com/api/v1/book/1 删除id=1的一本 6)资源过滤:通过接口传递参数来过滤资源 - 筛选、排序、限制 -- https://example.com/api/v1/books?limit=10 限制10条 2.响应部分 7)状态码:返回数据要标准状态码,通过在数据中 {"status": 200} -- SUCCESS("0", "查询成功") -- NODATA("1xx", "非正确,无数据,显示基本信息") -- FEAILED("2xx", "查询失败") 8)错误信息:请求失败需要标注错误信息 {"message": "请求参数不合法"} 9)操作结果:请求操作成功的返回结果 {"results": []} -- get:返回资源列表 | 返回单一资源 -- post:返回单一新增资源 -- put:返回更新的资源 -- patch:返回更新的资源 -- delete:返回空文档 10)子资源返回资源接口:返回的资源如果有子资源,返回子资源的链接地址,如查找书,书的封面图片就可以url表示
基于restful规范的原生django接口
主路由: url.py
from django.conf.urls import url,include from django.contrib import admin urlpatterns = [ url(r'^admin/', admin.site.urls), # 路由分发 url(r'^api/',include('api.urls')), ]
api应用的子路由: api/url.py
from django.conf.urls import url from . import views urlpatterns = [ # get查所有,post添加数据 url(r'^books/$', views.Book.as_view()), # 查一个,删一个,更新(整体,局部)一个 url(r'^books/(?P<pk>.*)/', views.Book.as_view()) ]
模型层: model.py
from django.db import models # Create your models here. class Book(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) class Meta: # 表名 db_table = 'red_book' verbose_name = '书籍' verbose_name_plural = verbose_name def __str__(self): return self.title
后台: admin.py
from django.contrib import admin from . import models admin.site.register(models.Book)
数据库迁移
>: python manage.py makemigrations >: python manage.py migrrate >: python manage.py createsuperuser
视图层: views.py
from django.http import JsonResponse from django.views import View from . import models class Book(View): # View 源码中判断wsgiref处理好的request中的请求方式,是GET,还是POST等,并自动掉对应的函数方法(通过调度(dispatch)分发请求) def get(self, request, *args, **kwargs): # GRT请求时,url后拼接的数据放到了request.GET中 print(request.GET) print(kwargs) # 有名分组的数据被放到kwargs中 pk = kwargs.get('pk') if not pk: # 群查 book_obj_list = models.Book.objects.all() # 数据信息列表 book_list = [] for obj in book_obj_list: dic = {} dic['title'] = obj.title dic['price'] = obj.price book_list.append(dic) # 响应数据(遵循接口规范:响应状态码, 提示信息, 操作结果) return JsonResponse({ 'status': 0, # 响应状态码 'msg': 'ok', # 提示信息 'results': book_list # 操作结果 }, json_dumps_params={'ensure_ascii': False}) else: # 单查 book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first() print(book_dic,type(book_dic)) if book_dic: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_dic }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 0, 'msg': '无结果', }, json_dumps_params={'ensure_ascii': False}) def post(self, request, *args, **kwargs): print(request.POST) # print(request.POST.dict()) # print(request.body) print(request.FILES) # POST请求时的Content-Type有三种:urlencoded,json,formdata # urlencoded:将request.body中的二进制数据处理放到对应的request.GET或request.POST中 # json:数据以二进制形式存放在request.body中不进行处理 try: book_obj = models.Book.objects.create(**request.POST.dict()) print(book_obj, type(book_obj)) if book_obj: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': {'title':book_obj.title, 'price':book_obj.price} }, json_dumps_params={'ensure_ascii':False}) except: return JsonResponse({ 'status': 1, 'msg': '参数有误', }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 2, 'msg': '新增失败', }, json_dumps_params={'ensure_ascii': False}) 补充: # postman可以完成不同方式的请求:get | post | put ... # postman发送数据包有三种方式:form-data | urlencoding | json # 原生django对urlencoding方式数据兼容最好
Postman接口工具
官方 https://www.getpostman.com/
get请求,携带参数采用Paramspost等请求,提交数据包可以采用三种方式:form-date、urlencoding、json所有请求都可以携带请求头
DRF框架
安装
>: pip3 install djangorestframework
注册 rest_framework
settings.py注册 app:INSTALLED_APPS = [ ..., 'rest_framework' ]
drf框架风格
from rest_framework.views import APIView from rest_framework.response import Response from rest_framework.request import Request from rest_framework.serializers import Serializer from rest_framework.settings import APISettings from rest_framework.filters import SearchFilter from rest_framework.pagination import PageNumberPagination from rest_framework.authentication import TokenAuthentication from rest_framework.permissions import IsAuthenticated from rest_framework.throttling import SimpleRateThrottle class Test(APIView): def get(self, request, *args, **kwargs): return Response('drf get ok')
drf请求生命周期
""" 1) 请求走的是APIView的as_view函数 2) 在APIView的as_view调用父类(django原生)的as_view,还禁用了 csrf 认证 3) 在父类的as_view中dispatch方法请求走的又是APIView的dispatch 4) 完成任务方法交给视图类的请求函数处理,得到请求的响应结果,返回给前台 """
请求模块:request对象
源码入口
APIView类的dispatch方法中:request = self.initialize_request(request, *args, **kwargs)
源码分析
# 将wsgiref的原生request二次封装得到def的request对象 request = self.initialize_request(request, *args, **kwargs) 点进去 # 在rest_framework.request.Request实例化方法中 self._request = request # 将原生request作为新request的_request属性 # 在rest_framework.request.Request的__getattr__方法中 try: return getattr(self._request, attr) # 访问属性完全兼容原生request except AttributeError: return self.__getattribute__(attr)
重点总结
# 1) drf 对原生request做了二次封装,request._request就是原生request # 2) 原生request对象的属性和方法都可以被drf的request对象直接访问(兼容) # 3) drf请求的所有url拼接参数均被解析到query_params中,所有数据包数据都被解析到data中
基于restful规范的drf接口
api应用的子路由: api/url.py
from django.conf.urls import url from . import views urlpatterns = [ # 这里的as_view是APIView类中的,作用是禁用了csrf_exempt,并返回view,调用了View类中的as_view方法 url(r'^test/$',views.Test.as_view()) ]
视图层: views.py
# APIView本质是继承了View class Test(APIView): def get(self, request, *args, **kwargs): # url 拼接的参数 print(request._request.GET) # 二次封装request print(request.GET) # 兼容 print(request.query_params) # 扩展,GET请求拼接的参数这里都有 return Response('drf get ok') def post(self, request, *args, **kwargs): # 请求携带的数据包 print(request._request.POST) # 二次封装方式,没有json方式的数据 print(request.POST) # 兼容,没有json方式的数据 print(request.data) # 拓展,兼容性最强,三种数据方式都可以 print(request.query_params) # post拼接的数据也可以接受到 return Response('drf post ok')
渲染模块:浏览器和Postman请求结果渲染数据的方式不一样
源码入口
APIView类的dispatch方法中:self.response = self.finalize_response(request, response, *args, **kwargs)
源码分析
# 最后解析reponse对象数据 self.response = self.finalize_response(request, response, *args, **kwargs) 点进去 # 拿到运行的解析类的对象们 neg = self.perform_content_negotiation(request, force=True) 点进去 # 获得解析类对象 renderers = self.get_renderers() 点进去 # 从视图类中得到renderer_classes请求类,如何实例化一个个对象形参解析类对象列表 return [renderer() for renderer in self.renderer_classes] # 重点:self.renderer_classes获取renderer_classes的顺序 # 自己视图类的类属性(局部配置) => # APIView类的类属性设置 => # 自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) => # drf配置文件的DEFAULT_RENDERER_CLASSES
REST_FRAMEWORK = { # drf提供的渲染类 'DEFAULT_RENDERER_CLASSES': [ 'rest_framework.renderers.JSONRenderer', 'rest_framework.renderers.BrowsableAPIRenderer', ], }
局部配置:某一个或一些实体类单独处理,在views.py视图类中提供对应的类属性
class Test(APIView): def get(self, request, *args, **kwargs): return Response('drf get ok') def post(self, request, *args, **kwargs): return Response('drf post ok') # 在setting.py中配置REST_FRAMEWORK,完成的是全局配置,所有接口统一处理 # 如果只有部分接口特殊化,可以完成 - 局部配置 from rest_framework.renderers import JSONRenderer class Test2(APIView): # 局部配置 renderer_classes = [JSONRenderer] def get(self, request, *args, **kwargs): return Response('drf get ok 2') def post(self, request, *args, **kwargs): return Response('drf post ok 2')