rest_framework_api规范
目录
一、什么是RESTful
二、什么是API
三、RESTful API规范
四、基于Django实现API
五、基于Django Rest Framework框架实现
一. 什么是RESTful
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
- 所有的数据,不管是通过网络获取的还是操作数据库获得(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
- 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
- 对互联网上的任意东西都视为资源,他认为一个url就是一个资源 比如:http://www.xxx.com/get_user/
二. 什么是API
1、什么是API?
答:API就是接口,提供的url。接口有两个用途:
- - 为别人提供服务
- - 前后端分离,一个写vue,一个写后端,他们之间都是通过ajax请求
三、RESTful API设计
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。
因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。
1、协议
API与用户的通信协议,总是使用HTTPs协议。
2、域名(URL)
规范
1.不用大写; 2.用中杠 - 不用下杠 _ ; 3.参数列表要encode; 4.URI中的名词表示资源集合,使用复数形式。 5.在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词(特殊情况可以使用动词),而且所用的名词往往与数据库的表格名对应。
域名的两种方式
# 方式一: 尽量将API部署在专用域名(会存在跨域问题)
https://api.example.com # 方式二:如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
https://example.org/api/
版本(Versioning)
应该将API的版本号放入URL。
https://api.example.com/v1/
https://api.example.com/v1/zoos
https://api.example.com/v1/zoos/1/animals
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。
详细域名
URI表示资源的两种方式:资源集合、单个资源。 资源集合: /zoos # 所有动物园 /zoos/1/animals # id为1的动物园中的所有动物 单个资源: /zoos/1 # id为1的动物园 /zoos/1;2;3 # id为1,2,3的动物园 结合版本
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
注意事项
在url中表达层级,用于 按实体关联关系进行对象导航 ,一般根据id导航。 过深的导航容易导致url膨胀,不易维护,如 GET /zoos/1/areas/3/animals/4 ,尽量使用查询参数代替路径中的实体导航,如 GET/animals?zoo=1&area=3 ;
3、HTTP请求(Request)
request方法
方法说明
# 常用的HTTP动词有下面五个(括号里是对应的SQL命令) GET(SELECT):从服务器取出资源(一项或多项)。即获取数据 POST(CREATE):在服务器新建一个资源。 即添加数据 PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源,即完整的数据)。即更新数据。与下面的PATCH类似。 PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性,即一部分数据)。即更新数据。 DELETE(DELETE):从服务器删除资源 。即删除数据 # 用的不多的 HEAD / OPTION HEAD:获取资源的元数据 OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的
reques方法的一些使用例子
GET /zoos # 列出所有动物园
GET /zoos/ID # 获取某个指定动物园的信息
GET /zoos/ID/animals # 列出某个指定动物园的所有animals POST /zoos # 新建一个动物园
POST /zoos/1/employees # 为id为1的动物园雇佣员工 PUT /zoos/ID # 更新某个指定动物园的信息(提供该动物园的全部信息) PATCH /zoos/ID # 更新某个指定动物园的信息(提供该动物园的部分信息) DELETE /zoos/ID # 删除某个动物园
DELETE /zoos/ID/animals/ID # 删除某个指定动物园的指定动物
DELETE /zoos/ID/animals/2;5;6;8 # 删除某个指定动物园的指定动物,使用";"表示多个
过滤信息(Filtering)
如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。
下面是一些常见的参数。
# 分页相关
?limit=10 # 指定返回记录的数量
?offset=10 # 指定返回记录的开始位置。
?page=2&per_page=100 # 指定第几页,以及每页的记录数。 # 排序相关
?sortby=name&order=asc # 指定返回结果按照哪个属性排序,以及排序顺序。 # 过滤条件
?type=1&age=16 # 允许一定的uri冗余,如 /zoos/1 与 /zoos?id=1
?animal_type_id=1 # 指定筛选条件 # 投影
?whitelist=id,name,email
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
4、返回结果(Response)
各HTTP方法成功处理后的数据格式
· |
response 格式 |
GET |
单个对象、集合 |
POST |
新增成功的对象 |
PUT/PATCH |
更新成功的对象 |
DELETE |
空 |
状态码(status codes)
# 服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。 200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。 # URI失效
随着系统发展,总有一些API失效或者迁移,对失效的API,返回404 not found 或 410 gone;对迁移的API,返回 301重定向。
状态码的完全列表参见这里。
Bookmarker
经常使用的、复杂的查询标签化,降低维护成本。
如:GET /trades?status=closed&sort=created,desc
快捷方式:GET /trades#recently-closed或者GET /trades/recently-closed
5、错误处理(Error handling)
1. 不要发生了错误却给2xx响应,客户端可能会缓存成功的http请求;
2. 正确设置http状态码,不要自定义;
3. Response body提供
即:返回的信息中将error作为键名,出错信息作为键值即可
1)错误的代码(日志/问题追查);
2)错误的描述文本(展示给用户)。
如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。
{
code: 10086,
error: "Invalid API key"
}
6、Hypermedia API 超媒体API
RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档。
{"link": {
"rel": "collection https://www.example.com/zoos", #表示这个API与当前网址的关系(collection关系,并给出该collection的网址)
"href": "https://api.example.com/zoos", #API路径
"title": "List of zoos", #API的标题
"type": "application/vnd.yourformat+json" #返回类型
}}
Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。
{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}
从上面可以看到,如果想获取当前用户的信息,应该去访问api.github.com/user,然后就得到了下面结果。
{
"message": "Requires authentication",
"documentation_url": "https://developer.github.com/v3"
}
四、基于Django实现API
方式一:FBV模式
from django.contrib import admin from django.conf.urls import url, include
from app01 import views
from app02 import views urlpatterns = [
url('admin/', admin.site.urls),
# path('hosts/',views.HostView.as_view()),
url('app02/', include('app02.urls'))
]
全局url.py
from app02 import views
from django.conf.urls import url
urlpatterns = [
url('^users/', views.users),
url('^user/(\d+)', views.user), url('^users/', views.UsersView.as_view()),
url('^user/', views.UserView.as_view()),
]
app02/url.py
from django.shortcuts import render,HttpResponse # Create your views here.
import json def users(request):
response = {'code':1000,'data':None} #code用来表示状态,比如1000代表成功,1001代表
response['data'] = [
{'name':'haiyan','age':22},
{'name':'haidong','age':10},
{'name':'haixiyu','age':11},
]
return HttpResponse(json.dumps(response)) #返回多条数据 def user(request,pk):
if request.method =='GET':
return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一条数据
elif request.method =='POST':
return HttpResponse(json.dumps({'code':1111})) #返回一条数据
elif request.method =='PUT':
pass
elif request.method =='DELETE':
pass
views.py
方式二:CBV模式
from app02 import views
from django.conf.urls import url
urlpatterns = [
url('^users/', views.UsersView.as_view()),
url('^user/', views.UserView.as_view()),
]
app02/url.py
from django.views import View
class UsersView(View):
def get(self,request):
response = {'code':1000,'data':None}
response['data'] = [
{'name': 'haiyan', 'age': 22},
{'name': 'haidong', 'age': 10},
{'name': 'haixiyu', 'age': 11},
]
return HttpResponse(json.dumps(response),stutas=200) class UserView(View):
def get(self,request,pk):
return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一条数据
def post(self,request,pk):
return HttpResponse(json.dumps({'code':1111})) #返回一条数据
def put(self,request,pk):
pass
def delete(self,request,pk):
pass
views.py
基于django实现的API许多功能都需要我们自己开发,这时候djangorestframework就给我们提供了方便,直接基于它来返回数据,总之原理都是一样的,就是给一个接口也就是url,让前端的人去请求这个url去获取数据,在页面上显示出来。这样也就达到了前后端分离的效果。下面我们来看看基于Django Rest Framework框架实现
五、基于Django Rest Framework框架实现
1、自定义认证规则
详见链接
class MyAuthtication(BasicAuthentication):
def authenticate(self, request):
token = request.query_params.get('token') #注意是没有GET的,用query_params表示
if token == 'zxxzzxzc':
return ('uuuuuu','afsdsgdf') #返回user,auth
raise APIException('认证错误') class UserView(APIView):
authentication_classes = [MyAuthtication,]
def get(self,request,*args,**kwargs):
print(request.user)
print(request.auth)
return Response('用户列表')
2、应用
主要是做Token验证 url中as_view里面调用了dispatch方法。
可以有两种方式
局部使用
from app01 import views
from django.conf.urls import url
urlpatterns = [
# django rest framework
url('^hosts/', views.HostView.as_view()),
url(r'^auth/', views.AuthView.as_view()),
]
urls.py
from django.shortcuts import render,HttpResponse
# Create your views here.
from rest_framework.views import APIView
from rest_framework.views import Request
from rest_framework.authentication import SessionAuthentication
from rest_framework.authentication import BaseAuthentication, BasicAuthentication
from rest_framework.parsers import JSONParser
from rest_framework.negotiation import DefaultContentNegotiation
from rest_framework.exceptions import APIException
from app01 import models
from rest_framework.response import Response #友好的显示返回结果 class AuthView(APIView):
#auth登录页面不需要验证,可设置
authentication_classes = [] #登录页面不需要认证
def get(self,request):
'''
接收用户名和密码
:param request:
:return:
'''
ret = {'code':1000,'msg':None}
user = request.query_params.get('username') pwd = request.query_params.get('password')
print(user,pwd)
obj = models.UserInfo.objects.filter(username=user,password=pwd).first()
print(obj)
if not obj :
ret['code'] = 1001
ret['msg'] = '用户名或者密码错误'
return Response(ret)
#创建随机字符串
import time
import hashlib
ctime = time.time()
key = '%s|%s'%(user,ctime)
m = hashlib.md5()
m.update(key.encode('utf-8'))
token = m.hexdigest() #保存数据
obj.token = token
obj.save() ret['token'] = token
return Response(ret) class HostView(APIView):
def dispatch(self, request, *args, **kwargs):
return super().dispatch(request, *args, **kwargs) # authentication_classes = [MyAuthtication] def get(self,request,*args,**kwargs):
print(request.user,'dddddddddddffffff')
print(request.auth,'dddddddddd')
#原来的request,django.core.handlers.wsgi.WSGIRequest
#现在的request ,rest_framework.request.Request
# print(request)
authentication_classes = [SessionAuthentication,BaseAuthentication]
# print(self.authentication_classes) # [<class 'rest_framework.authentication.SessionAuthentication'>,
# <class 'rest_framework.authentication.BasicAuthentication'>]
return HttpResponse('GET请求的响应内容') def post(self,request,*args,**kwargs):
pass
# try:
# try :
# current_page = request.POST.get("page")
#
# current_page = int(current_page)
# int("asd")
# except ValueError as e:
# print(e)
# raise #如果有raise说明自己处理不了了,就交给下面的一个去捕捉了
# except Exception as e:
# print("OK") return HttpResponse('post请求的响应内容') def put(self, request, *args, **kwargs):
return HttpResponse('put请求的响应内容')
Views.py
全局使用
#注册认证类
REST_FRAMEWORK = {
'UNAUTHENTICATED_USER': None,
'UNAUTHENTICATED_TOKEN': None, #将匿名用户设置为None
"DEFAULT_AUTHENTICATION_CLASSES": [
"app01.utils.MyAuthentication",
],
}
settings.py
from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import APIException
from app02 import models class MyAuthentication(BaseAuthentication):
def authenticate(self, request):
token=request.query_params.get('token')
print(token)
obj=models.UserInfo.objects.filter(token=token).first()
print(obj)
if obj:
return (obj.username,obj)
raise APIException('没有通过验证')
全局验证
注:rest_framewor是一个app需要settings里面设置。
参考or转发
http://www.cnblogs.com/haiyan123/p/8419972.html
rest_framework_api规范的更多相关文章
- iOS代码规范(OC和Swift)
下面说下iOS的代码规范问题,如果大家觉得还不错,可以直接用到项目中,有不同意见 可以在下面讨论下. 相信很多人工作中最烦的就是代码不规范,命名不规范,曾经见过一个VC里有3个按钮被命名为button ...
- node.js学习(三)简单的node程序&&模块简单使用&&commonJS规范&&深入理解模块原理
一.一个简单的node程序 1.新建一个txt文件 2.修改后缀 修改之后会弹出这个,点击"是" 3.运行test.js 源文件 使用node.js运行之后的. 如果该路径下没有该 ...
- 百度MIP页规范详解 —— canonical标签
百度MIP的规范要求必须添加强制性标签canonical,不然MIP校验工具会报错: 强制性标签<link rel="/^(canonical)$/"> 缺失或错误 这 ...
- JavaScript var关键字、变量的状态、异常处理、命名规范等介绍
本篇主要介绍var关键字.变量的undefined和null状态.异常处理.命名规范. 目录 1. var 关键字:介绍var关键字的使用. 2. 变量的状态:介绍变量的未定义.已定义未赋值.已定义已 ...
- JavaScript 开发规范
本篇主要介绍JS的命名规范.注释规范以及框架开发的一些问题. 目录 1. 命名规范:介绍变量.函数.常量.构造函数.类的成员等等的命名规范 2. 注释规范:介绍单行注释.多行注释以及函数注释 3. 框 ...
- c#语言规范
0x00 分类 C#语言规范主要有两个来源,即我们熟知的ECMA规范和微软的规范.尽管C#的ECMA规范已经前后修订4次,但其内容仅仅到C# 2.0为止.所以慕容为了方便自己和各位方便查询,在此将常见 ...
- OSGi规范的C#实现开源
这是大约在3-4年前完成的一个C#实现的OSGi框架,实现的过程参照了OSGi规范与与一些实现思路(感谢当时的那些资料与项目),此框架虽然仅在几个小型项目有过实际的应用,但OSGi的规范实现还是相对比 ...
- 【腾讯优测干货分享】如何降低App的待机内存(二)——规范测试流程及常见问题
本文来自于腾讯优测公众号(wxutest),未经作者同意,请勿转载,原文地址:https://mp.weixin.qq.com/s/806TiugiSJvFI7fH6eVA5w 作者:腾讯TMQ专项测 ...
- 超炫的HTML5粒子效果进度条 VS 如何规范而优雅地code
最近瞎逛的时候发现了一个超炫的粒子进度效果,有多炫呢?请擦亮眼镜! // _this.ch){ _this.particles.splice(i, 1); } }; this.Particle.p ...
随机推荐
- P1736 创意吃鱼法
题目描述 回到家中的猫猫把三桶鱼全部转移到了她那长方形大池子中,然后开始思考:到底要以何种方法吃鱼呢(猫猫就是这么可爱,吃鱼也要想好吃法 ^_*).她发现,把大池子视为01矩阵(0表示对应位置无鱼,1 ...
- Linux Shell常用技巧(四)
九. awk实用功能: 和sed一样,awk也是逐行扫描文件的,从第一行到最后一行,寻找匹配特定模板的行,并在这些行上运行“选择”动作.如果一个模板没有指定动作,这些匹配的行就被显示在屏幕上.如果一 ...
- Ext4文件系统架构分析(三) ——目录哈希、扩展属性与日志
struct dx_root Htree的内部节点: struct dx_node Htree 树根和节点中都存在的 Hash map: struct dx_entry 1.20 扩展属性EA 扩展属 ...
- java.sql.SQLSyntaxErrorException: ORA-01722: 无效数字
### Error updating database. Cause: java.sql.SQLSyntaxErrorException: ORA-01722: 无效数字 ### The error ...
- MySQL基础----py全栈
目录 MySQL基础----py全栈 一.引言 1.什么是数据? 2.什么是数据库(DB)? 3.什么是数据库管理系统(DBMS)? 4.什么是数据库系统? 5.数据库管理系统由来 6.什么是数据模型 ...
- 基于jquery的插件turn.js学习笔记
基于jquery的插件turn.js学习笔记 简介 turn.js是一个可以实现3d书籍展示效果的jq插件,使用html5和css3来执行效果.可以很好的适应于ios和安卓等触摸设备. How it ...
- Scala的高级特性
高阶函数 概念 Scala混合了面向对象和函数式的特性,我们通常将可以作为参数传递到方法中的表达式叫做函数.在函数式编程语言中,函数是“头等公民”,高阶函数包含:作为值的函数.匿名函数.闭包.柯里化等 ...
- 基于BM3803处理器平台的PCI软硬件调试问题汇总(持续更新中)
一:相关基本配置: FPGA: XILINX XC5VFX130T-1FFG1738 PCI接口部分使用XILINX提供的pci32_v4_8硬核:PCI控制器由FPGA逻辑实现,主要完成PCI设备 ...
- 用NI的数据采集卡实现简单电子测试之4——半导体温度传感器
本文从本人的163博客搬迁至此. 为了展示NImax(Measurement & Automation explorer)的强大配置功能,做了一个半导体温度传感器测试的示例. 一.半导体温度传 ...
- lxml etree xpath
from lxml import etree #####################基本用法: ##################### html = ''' <h1 class=&quo ...