Django之 RESTful规范
RESTful 规范
一、什么是RESTful
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
- REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
- 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
- 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
二、RESTful API设计
API与用户通信协议,总是使用
域名: 尽量将API部署在专用域名(会存在跨域问题)(https://api.example.com )或(https://example.org/api/ )
路径,视网络上任何东西都是资源,均使用名词表示(可以是复数)
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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。更多看这里:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
错误处理,应该返回错误信息, error 当做key
{error: "Invalid API key" }
返回 结果,针对不同操作,服务器向用户返回的给过应该符合以下规范
GET /collection:返回资源对象的列表(数组) GET /collection/resource:返回单个资源对象 POST /collection:返回新生成的资源对象 PUT /collection/resource:返回完整的资源对象 PATCH /collection/resource:返回完整的资源对象 DELETE /collection/resource:返回一个空文档
Hypermedia API,RESTful API 最好做到 Hypermedia, 即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步该怎么做。
{"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': 'lqz2', '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': 'lqz', 'age': 18}return HttpResponse(json.dumps(dic))def post(self, request):dic = {'status': 200, 'msg': '修改成功'}return JsonResponse(dic)
转载于:https://www.cnblogs.com/qianzhengkai/p/11115955.html
Django之 RESTful规范相关推荐
- Django框架深入了解_01(Django请求生命周期、开发模式、cbv源码分析、restful规范、跨域、drf的安装及源码初识)
阅读目录 一.Django请求生命周期: 二.WEB开发模式: 三.cbv源码分析: 四.认识RESTful 补充知识:跨域 五.基于原生django开发restful的接口 六.drf安装.使用.A ...
- Django RESTful规范
Restful : web服务交互: 我们在浏览器中能看到的每个网站, 都是一个web服务. 那么我们在提供每个web服务的时候, 都需要前后端交互. 前后端交互就一定有一些实现方案, 我们通常叫we ...
- restful规范和APIView
django生命周期 1.先进入wsgi协议的web服务器2.进入django的中间件3.路由4.视图5.取模板,取数据,用数据渲染模板6.返回模板的字符串7.在wsgi中封装后发送给浏览器 开发模式 ...
- Drf从入门到精通一(API接口、Postman、Restful规范、序列化、快速使用drf、CBV源码分析)
文章目录 一.前后端开发模式 二.API接口 三.接口测试工具Postman 四.Restful规范 五.序列化反序列化 六.DjangoRestFramework快速使用 七.CBV源码分析 一.前 ...
- REST-Framework: RESTful规范
目录 一 什么是RESTful 二 RESTful API设计 三 基于原生的Django实现 一 什么是RESTful REST与技术无关,代表的是一种软件架构风格,REST是Representa ...
- drf1 rest restful规范
web服务交互 我们在浏览器中能看到的每个网站,都是一个web服务.那么我们在提供每个web服务的时候,都需要前后端交互,前后端交互就一定有一些实现方案,我们通常叫web服务交互方案.目前主流的三种w ...
- koa --- restful规范及其栗子
遵循Restful规范的简单的栗子 前端代码: <html><head><script src="https://cdn.jsdelivr.net/npm/vu ...
- php restful规范,RESTFul API规范 详细指南
RESTFul规范 RESTFul是一种HTTP API接口规范,只要满足的RESTFul规范,即可称为RESTFul API. 既然是接口,我们先来了解一下,他和传统的API接口有何不同吧. 本文以 ...
- Restful规范-开发api接口
web服务交互 我们在浏览器中能看到的每个网站,都是一个web服务.那么我们在提供每个web服务的时候, 都需要前后端交互,前后端交互就一定有一些实现方案,我们通常叫web服务交互方案. 目前主流的三 ...
最新文章
- 26张图带你彻底搞懂volatile关键字
- R语言使用psych包的fa函数对指定数据集进行因子分析(输入数据为相关性矩阵)、使用rotate参数指定进行斜交旋转提取因子、使用nfactors参数指定抽取的因子个数、fa函数因子分析结果解读
- 解决html页面闪烁,解决前端页面闪烁问题(转载)
- conda环境里安装pydot
- C#学习笔记——MDI窗体(多文档界面)
- 机房配电柜、配电箱在安装时应该注意哪些“禁忌”?
- signature=ae032dcfdc89568ef19ec0c956de36e7,来用百度密语吧!!!
- python飞机大战资料-Python之游戏开发-飞机大战
- Mathematica函数大全
- 收藏 | 13则PyTorch使用的小窍门
- Visual Studio DSL 入门 1 --- 什么是特定领域开发和DSL
- jQuery 判断是否包含某个属性
- React Hooks 起手式,实现一个「高颜值实用」的色彩设计工具
- iOS 6分享列表——UIActivityViewController详解
- 拯救者 linux 无线网卡驱动下载,联想y7000无线网卡驱动下载-联想拯救者y7000无线网卡驱动v19.51.22.2 官方版 - 极光下载站...
- 怎样通过迅捷PDF编辑器来修改PDF文件
- matlab tanh导数,谁知道tanh(x)的二阶导数-tanh-数学-郝啪韭同学
- sumifs 汇总_空标准单元格的SUMIFS公式
- html中table整体缩小,html-如何缩小表格样式中的间隙?
- 二零二二,闯北十年,及时行乐,此生尽兴
热门文章
- php 数组降维,php 数组去重的方法参考(一维数组去重、二维数组去重)
- rocketmq 消费方式_RocketMQ事务消费和顺序消费详解
- c语言基本字符集ppt,C语言的字符集和保留字知识讲稿.ppt
- 了解jvm自动内存分配和内存自动回收的重要性
- 电脑技巧:Win10无线投屏功能介绍
- Centos7搭建SVN服务步骤说明
- 2010年安大计算机录取名单,2021安徽大学考研拟录取名单已公布
- python图表可视化工具_比Excel制图更强大,Python可视化工具Altair入门教程
- linux应用程序文件丢失,详谈Ubuntu软件管理丢失的功能
- eclipse安卓工程的构建、配置连接模拟器、安卓工程结构介绍