Django-rest framework框架的安装配置和简介、Restful接口规范、基于原生django书写知足restful规范的接口

Django-rest framework框架的安装配置、简介、Restful接口规范、基于原生django书写知足restful规范的接口

drf框架安装配置

一.安装

pip3 install djangorestframework

二.配置

# 注册drf app INSTALLED_APPS = [ # ... 'rest_framework', ]

三.特色

# 具体功能在具体模块下 from rest_framework.request import Request from rest_framework.response import Response from rest_framework.exceptions import APIException from rest_framework.filters import OrderingFilter from rest_framework.views import APIView from rest_framework.pagination import PageNumberPagination from rest_framework.settings import APISettings # 自定义drf配置 - 在本身的settings.py REST_FRAMEWORK = { # 自定义修改drf的配置们 }

什么是drf框架

1、drf优势

1. Django-rest framework能够帮助咱们简化如下两部分的代码编写，大大提升REST API的开发速度。

• 在序列化与反序列化时，虽然操做的数据不尽相同，可是执行的过程倒是类似的，也就是说这部分代码是能够复用简化编写的。
• 在开发REST API的视图中，虽然每一个视图具体操做的数据不一样，但增、删、改、查的实现流程基本套路化，因此这部分代码也是能够复用简化编写的。
  • 增：校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
  • 删：判断要删除的数据是否存在 -> 执行数据库删除
  • 改：判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
  • 查：查询数据库 -> 将数据序列化并返回

2. Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。一般简称为DRF框架或REST framework。

3. DRF框架是创建在Django框架基础之上，由Tom Christie大牛二次开发的开源项目。

2、特色

• 提供了定义序列化器Serializer的方法，能够快速根据 Django ORM 或者其它库自动序列化/反序列化；
• 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
• 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，知足各类须要；
• 多种身份认证和权限认证方式的支持；
• 内置了限流系统；
• 直观的 API web 界面；
• 可扩展性，插件丰富

drf框架的做用

做用：写接口

什么是接口：

URL（先后台信息交互的媒介）

明确了请求方式，提供对应后台所需参数，请求url连接能够获得后台的相应数据

怎么写接口：

参照某种规则（规范）书写url连接，同时根据规则制定请求方式，数据与响应结果。

接口文档：

提供给先后台开发人员与测试人员查看

接口规范：

webapi接口规范：restful

URL设计

请求方式

数据的安全保障

利用https协议

接口特征表现的两种方式

• https://api.baidu.com
• https://www.baidu.com/api

注：看到api字眼，就表明该请求url连接是完成先后台数据交互的

多数据版本共存

• https://api.baidu.com/v1
• https://api.baidu.com/v2

注：url连接中的v一、v2就是不一样数据版本的提现（只有在一种数据资源有多版本的状况下）

数据即资源

接口通常都是完成先后台数据的交互，交互数据就称之为资源

eg：https://api.baidu.com/books

注：通常提倡用资源的复数形式，不要出现操做资源的动词

资源操做由请求方式决定

操做资源通常都会涉及到增删改查，咱们提供请求方式来标识增删改查动做,eg:

''' 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的书 '''

响应状态码

200：常规请求

201：建立成功

301：永久重定向

302：暂时重定向

403：请求无权限

404：请求路径不存在

405：请求方法不存在

500：服务器异常

响应结果

响应数据要有状态码、状态信息以及数据自己

}
"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" } ... ] }

须要URL请求的资源须要访问资源的请求连接

{
 "status": 0, "msg": "ok", "results":[ { "name":"肯德基(罗餐厅)", "img": "https://image.baidu.com/kfc/001.png" } ... ] }

基于原生django书写知足restful规范的接口

两个url 对应 一个视图类 完成十大接口，用到路由分发

路由分发须要在app文件夹下也建立一个urls.py文件

项目名下的urls.py

from django.conf.urls import url, include from django.contrib import admin from api import views urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^test/', views.Test.as_view()), # 路由分发 url(r'^api/', include('api.urls')), ]

app名下的urls.py：api\urls.py

from django.conf.urls import url from . import views urlpatterns = [ url(r'^books/$', views.Book.as_view()), # 群查 url(r'^books/(?P<pk>\d+)/$', views.Book.as_view()), # 单查 ]

上面两个url都对应视图函数文件内的视图类Book

view.py

from django.http import JsonResponse from django.views import View from . import models from rest_framework.views import APIView class Book(View): def get(self, request, *args, **kwargs): pk = kwargs.get('pk', None) if pk: # 单查 book_dic = models.Book.objects.filter(pk=pk).values('name', 'price').first() results = book_dic else: # 群查 book_query = models.Book.objects.values('name', 'price') results = list(book_query) if not results: return JsonResponse({ 'status': 1, 'msg': 'data error', }) return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': results })

CBV请求生命周期

as_view()方法完成路由匹配 => url请求会调用as_view()的返回值视图函数view => 调用dispatch()方法完成请求分发 => 视图类的具体视图方法处理请求 => 返回给前台