drf框架的全称:diango-rest framework,是一种后端框架。
接口
接口:连接两个物质的媒介,完成信息交互。而web程序中的接口:作为前台页面与后台数据库连接的媒介。
web接口组成:
url:长得像放回数据的url链接。如api.baidu.map/search,一访问后台返回给你的是一大堆查询到的数据 结果 。作为接口最主要的部分。
请求参数:前台按照指定的key提供数据给后台
响应数据:后台与数据库交互后将数据反馈给前台
一个规定的请求参数的url访问后能返回对应的结果的url链接。
restful接口规范
接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据。
如何写接口:接口规范是规范化书写接口的,写接口要写 url、响应数据。
注意:如果将请求参数也纳入考量范围,那就是在写 接口文档
url
1)用api关键字来标识接口url。如:api.baidu.com | www.baidu.com/api
2)考虑到接口数据安全性,优先选择https协议。
3)如果一个接口中有多个不同的版本,需要在url中标识体现出来。如:api.baidu.com/v1/... | api.baidu.com/v2/...
4)接口操作的数据源称之为资源,在url中一般采用资源复数形式,一个接口可以概括为对资源的多种操作方式。如:api.baidu.com/books | www.baidu.com/api/books(pk),操作单个资源的时候,需要用到主键pk。
5)请求方式有多种,用一个url处理如何保证不混乱 ---> 通过请求方式标识操作资源的方式。
/books get 获取所有
/books post 增加一个(多个)
/books/(pk) delete 删除一个
/books/(pk) put 整体更新一个
/books/(pk) patch 局部更新一个
6) 资源往往涉及数据的各种操作方式 ---> 筛选、排序、限制。如:api.baidu.com/books/?search=西&ordering=-price&limit=3
响应数据
1) http请求的响应会有相对应的响应码,接口是用来返回操作的资源数据,可以拥有操作数据结果的状态码。status: 0(操作资源成功) ;1(操作资源失败); 2(操作资源成功,但没匹配结果)
注:资源状态码不像http状态码,一般都是后台与前台或是客户约定的
2) 资源的状态码文字提示。如:status ok '账号有误' '密码有误' '用户锁定'
3) 资源本身。results。
注意:删除资源成功不做任何数据返回(返回空字符串)
4) 不能直接放回的资源(子资源、图片、视频等资源),返回该资源的url链接
1 from django.conf.urls import url, include 2 from django.contrib import admin 3 4 5 urlpatterns = [, 6 url(r'^admin/', admin.site.urls), # 路由分发,分发给api中的路由 7 url(r'^api/', include('api.urls')) 8 ]
1 from django.conf.urls import url 2 from . import views 3 4 urlpatterns = [ 5 url(r'^books/', views.Book.as_view()), # 执行as_view这个函数,再拿到执行结果 6 url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), 7 ]
from django.db import models class Book(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) class Meta: db_table = 'old_boy_book' verbose_name = '书籍' verbose_name_plural = verbose_name def __str__(self): return '《%s》' % self.title
后台层:admin.py
1 from django.contrib import admin 2 from . import models 3 4 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): def get(self, request, *args, **kwargs): pk = kwargs.get('pk') # 有名分组 if not pk: # 如果有pk,查单个。如果没有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() if book_dic: return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': book_dic }, 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方式数据兼容最好 def post(self, request, *args, **kwargs): # 前台通过urlencoding方式提交数据 try: book_obj = models.Book.objects.create(**request.POST.dict()) 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接口工具
在官网下载安装https://www.getpostman.com/ ,详细安装步骤可见 http://www.onlinedown.net/soft/971602.htm 。
get请求,携带参数采用Params。post等请求,不需要pk主键, 在Body中提交数据包可以采用三种方式:form-date、urlencoding、json。所有请求都可以携带请求头
Drl安装和与封装风格
安装所要输入的指令 >: pip3 install djangorestframework
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) 完成任务方法交给视图类的请求函数处理,得到请求的响应结果,返回给前台