手机网站案列,十大外贸平台,临沂龙文网站建设,中小微企业服务平台四 RESTful API规范 REST全称是Representational State Transfer#xff0c;中文意思是表述#xff08;编者注#xff1a;通常译为表征性状态转移#xff09;。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格#xff0c;尤其适用…四 RESTful API规范 REST全称是Representational State Transfer中文意思是表述编者注通常译为表征性状态转移。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的对外提供的是数据资源的访问接口所以在定义接口时客户端访问的URL路径就表示这种要操作的数据资源。
事实上我们可以使用任何一个框架都可以实现符合restful规范的API接口。
4.1 数据的安全保障 url链接一般都采用https协议进行传输 注采用https协议可以提高数据交互过程中的安全性
4.2 接口特征表现 用api关键字标识接口url https://api.baidu.comhttps://www.baidu.com/api注看到api字眼就代表该请求url链接是完成前后台数据交互的
4.3 多数据版本共存 在url链接中标识数据版本 https://api.baidu.com/v1https://api.baidu.com/v2注url链接中的v1、v2就是不同数据版本的体现只有在一种数据资源有多版本情况下
4.4 数据即是资源均使用名词可复数 接口一般都是完成前后台数据的交互交互的数据我们称之为资源 https://api.baidu.com/usershttps://api.baidu.com/bookshttps://api.baidu.com/book注一般提倡用资源的复数形式在url链接中奖励不要出现操作资源的动词错误示范https://api.baidu.com/delete-user 特殊的接口可以出现动词因为这些接口一般没有一个明确的资源或是动词就是接口的核心含义 https://api.baidu.com/place/searchhttps://api.baidu.com/login
4.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的书https://api.baidu.com/books/1 - delete请求删除主键为1的书
4.6 过滤通过在url上传参的形式传递搜索条件
https://api.example.com/v1/zoos?limit10指定返回记录的数量https://api.example.com/v1/zoos?offset10指定返回记录的开始位置https://api.example.com/v1/zoos?page2per_page100指定第几页以及每页的记录数https://api.example.com/v1/zoos?sortbynameorderasc指定返回结果按照哪个属性排序以及排序顺序https://api.example.com/v1/zoos?animal_type_id1指定筛选条件
4.7 响应状态码
4.7.1 正常响应
响应状态码2xx 200常规请求201创建成功
4.7.2 重定向响应
响应状态码3xx 301永久重定向302暂时重定向
4.7.3 客户端异常
响应状态码4xx 403请求无权限404请求路径不存在405请求方法不存在
4.7.4 服务器异常
响应状态码5xx 500服务器异常
4.8 错误处理应返回错误信息error当做key
{error: 无权限操作
}4.9 返回结果针对不同操作服务器向用户返回的结果应该符合以下规范
GET /collection返回资源对象的列表数组
GET /collection/resource返回单个资源对象
POST /collection返回新生成的资源对象
PUT /collection/resource返回完整的资源对象
PATCH /collection/resource返回完整的资源对象
DELETE /collection/resource返回一个空文档4.10 需要url请求的资源需要访问资源的请求链接
# Hypermedia APIRESTful 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接口开发最核心最常见的一个过程就是序列化所谓序列化就是把数据转换格式序列化可以分两个阶段
序列化 把我们识别的数据转换成指定的格式提供给别人。
例如我们在django中获取到的数据默认是模型对象但是模型对象数据无法直接提供给前端或别的平台使用所以我们需要把数据进行序列化变成字符串或者json数据提供给别人。
反序列化把别人提供的数据转换/还原成我们需要的格式。
例如前端js提供过来的json数据对于python而言就是字符串我们需要进行反序列化换成模型类对象这样我们才能把数据保存到数据库中。
五 Django Rest_Framework
核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架可以快速的开发REST API接口应用。在REST framework中提供了序列化器Serialzier的定义可以帮助我们简化序列化与反序列化的过程不仅如此还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。 官方文档Home - Django REST framework
github: GitHub - encode/django-rest-framework: Web APIs for Django.
特点
提供了定义序列化器Serializer的方法可以快速根据 Django ORM 或者其它库自动序列化/反序列化提供了丰富的类视图、Mixin扩展类简化视图的编写丰富的定制层级函数视图、类视图、视图集合到自动生成 API满足各种需要多种身份认证和权限认证方式的支持[jwt]内置了限流系统直观的 API web 界面可扩展性插件丰富
六 环境安装与配置
DRF需要以下依赖
Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)Django (1.10, 1.11, 2.0)
DRF是以Django扩展应用的方式提供的所以我们可以直接利用已有的Django环境而无需从新创建。若没有Django环境需要先创建环境安装Django
6.1 安装DRF
前提是已经安装了django建议安装在虚拟环境
# mkvirtualenv drfdemo -p python3
# pip install djangopip install djangorestframework
pip install pymysql6.1.1 创建django项目
cd ~/Desktop
django-admin startproject drfdemo使用pycharm打开项目设置虚拟环境的解析器并修改manage.py中的后缀参数。
6.2 添加rest_framework应用
在settings.py的INSTALLED_APPS中添加’rest_framework’。
INSTALLED_APPS [...rest_framework,
]接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口主要有以下三个步骤
将请求的数据如JSON格式转换为模型类对象操作数据库将模型类对象转换为响应的数据如JSON格式
接下来我们快速体验下四天后我们学习完成drf以后的开发代码。接下来代码不需要理解看步骤。
6.3 体验drf完全简写代码的过程了解
6.3.1. 创建模型操作类
class Student(models.Model):# 模型字段name models.CharField(max_length100,verbose_name姓名)sex models.BooleanField(default1,verbose_name性别)age models.IntegerField(verbose_name年龄)class_null models.CharField(max_length5,verbose_name班级编号)description models.TextField(max_length1000,verbose_name个性签名)class Meta:db_tabletb_studentverbose_name 学生verbose_name_plural verbose_name为了方便测试所以我们可以先创建一个数据库。
create database students charsetutf8;6.3.1.1 执行数据迁移
把students子应用添加到INSTALL_APPS中 初始化数据库连接
安装pymysql
pip install pymysql主引用中__init__.py设置使用pymysql作为数据库驱动
import pymysqlpymysql.install_as_MySQLdb()settings.py配置文件中设置mysql的账号密码
DATABASES {# default: {# ENGINE: django.db.backends.sqlite3,# NAME: os.path.join(BASE_DIR, db.sqlite3),# },default: {ENGINE: django.db.backends.mysql,NAME: students,HOST: 127.0.0.1,PORT: 3306,USER: root,PASSWORD:123,},
}终端下执行数据迁移。
python manage.py makemigrations
python manage.py migrate错误列表
# 执行数据迁移 python manage.py makemigrations 报错如下解决方案
注释掉 backends/mysql/base.py中的35和36行代码。# 执行数据迁移发生以下错误解决方法
backends/mysql/operations.py146行里面新增一个行代码 6.3.2. 创建序列化器
例如在django项目中创建学生子应用。
python manage.py startapp students在syudents应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。
# 创建序列化器类回头会在试图中被调用
class StudentModelSerializer(serializers.ModelSerializer):class Meta:model Studentfields __all__model 指明该序列化器处理的数据字段从模型类BookInfo参考生成fields 指明该序列化器包含模型类中的哪些字段’all‘指明包含所有字段
6.3.3. 编写视图
在students应用的views.py中创建视图StudentViewSet这是一个视图集合。
from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):queryset Student.objects.all()serializer_class StudentModelSerializerqueryset 指明该视图集在查询数据时使用的查询集serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
6.3.4. 定义路由
在students应用的urls.py中定义路由信息。
from . import views
from rest_framework.routers import DefaultRouter# 路由列表
urlpatterns []router DefaultRouter() # 可以处理视图的路由器
router.register(students, views.StudentViewSet) # 向路由器中注册视图集urlpatterns router.urls # 将路由器中的所以路由信息追到到django的路由列表中最后把students子应用中的路由文件加载到总路由文件中.
from django.contrib import admin
from django.urls import path,includeurlpatterns [path(admin/, admin.site.urls),path(stu/,include(students.urls)),
]6.3.5. 运行测试
运行当前程序与运行Django一样
python manage.py runserver在浏览器中输入网址127.0.0.1:8000可以看到DRF提供的API Web浏览页面 1点击链接127.0.0.1:8000/stu/students 可以访问获取所有数据的接口呈现如下页面 2在页面底下表单部分填写学生信息可以访问添加新学生的接口保存学生信息 点击POST后返回如下页面信息 3在浏览器中输入网址127.0.0.1:8000/stu/students/5/可以访问获取单一学生信息的接口id为5的学生呈现如下页面 4在页面底部表单中填写学生信息可以访问修改学生的接口 点击PUT返回如下页面信息 5点击DELETE按钮可以访问删除学生的接口 返回如下页面 七 CBV源码分析
# 视图层
from django.shortcuts import render, HttpResponse
from django.views import View
class CBVTest(View):# 通过调度(dispatch)分发请求def dispatch(self, request, *args, **kwargs):passsuper().dispatch(request, *args, **kwargs)passdef get(self, request):return render(request, cbv.html)def post(self, request):return HttpResponse(cbv post method)
!-- 模板层 --
form action/cbv/ methodpost{% csrf_token %}input typetext nameusrbutton typesubmit提交/button
/form
# 路由层
from app import views
urlpatterns [url(r^cbv/, views.CBVTest.as_view()),
] 八 drf基本使用及request源码分析
8.1 APIView的使用
# 1安装drfpip3 install djangorestframework
# 2settings.py注册appINSTALLED_APPS [..., rest_framework]
# 3基于cbv完成满足RSSTful规范的接口
# 视图层
from rest_framework.views import APIView
from rest_framework.response import Response
user_list [{id: 1, name: Bob}, {id: 2, name: Tom}]
class Users(APIView):def get(self, request, *args, **kwargs):return Response({status: 0,msg: ok,results: user_list})def post(self, request, *args, **kwargs):# request对formdataurlencodedjson三个格式参数均能解析name request.data.get(name)id len(user_list) 1user {id: id, name: name}user_list.append(user)return Response({status: 0,msg: ok,results: user})
# 路由层
from app import views
urlpatterns [url(r^users/, views.Users.as_view()),
]8.2 APIView和Request对象源码分析
8.2.1 APIView
# as_view()# 核心走了父类as_viewview super(APIView, cls).as_view(**initkwargs)# 返回的是局部禁用csrf认证的view视图函数return csrf_exempt(view)# dispatch(self, request, *args, **kwargs)# 二次封装request对象request self.initialize_request(request, *args, **kwargs)# 自定义request规则self.initial(request, *args, **kwargs)# initialize_request(self, request, *args, **kwargs)# 原生request封装在request._request# initial(self, request, *args, **kwargs)# 认证self.perform_authentication(request)# 权限self.check_permissions(request)# 频率self.check_throttles(request)8.2.2 Request对象
