REST-Framework: RESTful规范
目录
一 什么是RESTful
二 RESTful API设计
三 基于原生的Django实现
一 什么是RESTful
REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
二 RESTful API设计
RESTful 的API设计也就是开发者们常说的(RESTful的十大规范), 并不是说要完完全全的按照RESTful规范写出来的API才称作为RESTful API , 按照其中的某几个规范,开发出来的也可以成为遵循RESTful规范的API
API与用户的通信协议,总是使用HTTPs协议。
域名
https://api.example.com 尽量将API部署在专用域名(会存在跨域问题)
https://example.org/api/ API很简单
版本
在接口首次写好供用户使用后, 后续如果有更改需求, 不能在原来接口上改, 需要开发另外一个版本来满足用户需求, 这样我们把原来的版本叫做V1或者1版本, 更改后的成为v2或者2版本
URL,如:https://api.example.com/v1/
请求头跨域时,引发发送多次请求
路径,视网络上任何东西都是资源,均使用名词表示(可复数)
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
method: 根据不容的请求方式来确定不同的请求操作
GET :从服务器取出资源(一项或多项)
POST :在服务器新建一个资源
PUT :在服务器更新资源(客户端提供改变后的完整资源)
PATCH :在服务器更新资源(客户端提供改变的属性)
DELETE :从服务器删除资源
过滤,通过在url上传参数的形式传递搜索条件
https://api.example.com/v1/zoos?limit=10:指定返回记录的数量
https://api.example.com/v1/zoos?offset=10:指定返回记录的开始位置
https://api.example.com/v1/zoos?page=2&per_page=100:指定第几页,以及每页的记录数
https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序
https://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件
状态码
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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
更多状态码看这里:更多的状态码
错误处理,应返回错误信息,error当做key。
1 2 3 |
|
返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范。
1
2
3
4
5
6
GET
/
collection:返回资源对象的列表(数组)
GET
/
collection
/
resource:返回单个资源对象
POST
/
collection:返回新生成的资源对象
PUT
/
collection
/
resource:返回完整的资源对象
PATCH
/
collection
/
resource:返回完整的资源对象
DELETE
/
collection
/
resource:返回一个空文档
Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
1
2
3
4
5
6
{
"link"
: {
"rel"
:
"collection https://www.example.com/zoos"
,
"href"
:
"https://api.example.com/zoos"
,
"title"
:
"List of zoos"
,
"type"
:
"application/vnd.yourformat+json"
}}
摘自:http://www.ruanyifeng.com/blog/2014/05/restful_api.html
三 基于原生的Django实现
路由系统:
urlpatterns = [url(r'^users/$', views.Users.as_view()),url(r'^users2/$', views.user2),]
视图函数:
import jsondef user2(request):if request.method=='GET':dic = {'status':200,'name': 'allen', 'age': 18}return HttpResponse(json.dumps(dic))elif request.method=='POST':dic = {'status': 200, 'msg': '修改成功'}return JsonResponse(dic)class Users(View):def get(self, request):dic = {'status':200,'name': 'allen', 'age': 18}return HttpResponse(json.dumps(dic))def post(self, request):dic = {'status': 200, 'msg': '修改成功'}return JsonResponse(dic)
REST-Framework: RESTful规范相关推荐
- Django框架深入了解_01(Django请求生命周期、开发模式、cbv源码分析、restful规范、跨域、drf的安装及源码初识)
阅读目录 一.Django请求生命周期: 二.WEB开发模式: 三.cbv源码分析: 四.认识RESTful 补充知识:跨域 五.基于原生django开发restful的接口 六.drf安装.使用.A ...
- Drf从入门到精通一(API接口、Postman、Restful规范、序列化、快速使用drf、CBV源码分析)
文章目录 一.前后端开发模式 二.API接口 三.接口测试工具Postman 四.Restful规范 五.序列化反序列化 六.DjangoRestFramework快速使用 七.CBV源码分析 一.前 ...
- drf1 rest restful规范
web服务交互 我们在浏览器中能看到的每个网站,都是一个web服务.那么我们在提供每个web服务的时候,都需要前后端交互,前后端交互就一定有一些实现方案,我们通常叫web服务交互方案.目前主流的三种w ...
- restful规范和APIView
django生命周期 1.先进入wsgi协议的web服务器2.进入django的中间件3.路由4.视图5.取模板,取数据,用数据渲染模板6.返回模板的字符串7.在wsgi中封装后发送给浏览器 开发模式 ...
- koa --- restful规范及其栗子
遵循Restful规范的简单的栗子 前端代码: <html><head><script src="https://cdn.jsdelivr.net/npm/vu ...
- Django之 RESTful规范
RESTful 规范 一.什么是RESTful REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为"表征 ...
- php restful规范,RESTFul API规范 详细指南
RESTFul规范 RESTFul是一种HTTP API接口规范,只要满足的RESTFul规范,即可称为RESTFul API. 既然是接口,我们先来了解一下,他和传统的API接口有何不同吧. 本文以 ...
- Django RESTful规范
Restful : web服务交互: 我们在浏览器中能看到的每个网站, 都是一个web服务. 那么我们在提供每个web服务的时候, 都需要前后端交互. 前后端交互就一定有一些实现方案, 我们通常叫we ...
- Restful规范-开发api接口
web服务交互 我们在浏览器中能看到的每个网站,都是一个web服务.那么我们在提供每个web服务的时候, 都需要前后端交互,前后端交互就一定有一些实现方案,我们通常叫web服务交互方案. 目前主流的三 ...
最新文章
- dao层和service层和control_maven分模块构建SSM普通web项目:service层代码编写
- 华为NFV实验室一周年:打造开放合作生态链 加速NFV产业化
- ubuntu+idea intellij配置android开发环境
- TypeError: 'MongoClient' object is not callable
- Linux如何将文件中内容放到粘贴板上
- windows中使用mysql配置my.ini时的坑
- ztree判断是否是叶子节点
- 使用C#开发纽曼USB来电小秘书客户端小结
- lsqcurvefit拟合结果为复数_高考数学专题突破,向量运算与复数运算、算法、推理与证明,方法规律总结,知识归纳,易错示警...
- MAC共享目录让WINDOWS访问
- Spring Cloud Alibaba Sentinel之持久化篇
- Android gdb 调试
- MATLAB安装与解密
- Kafka配置broker映射错误报错Discovered coordinator xxx rack: null
- opengl——绘制一个点
- calcbusiness使用教程_Calc Business
- Android应用架构之Retrofit
- Swift学习之--TableView的基本使用
- android ios 实时视频,Twitter推出适用于Android和iOS设备的实时视频
- 鸿蒙os官网2.0,鸿蒙 OS 2.0正式发布,看看用户体验评价,内附可升级型号名单!...