文档章节

十万个为什么之什么是resultful规范

尾生
 尾生
发布于 2018/12/11 00:55
字数 1400
阅读 18
收藏 0

起源

越来越多的人开始意识到,网站即软件,而且是一种新型的软件。这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点。

RESTful架构,就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。


什么是resultful

REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性。
对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)

resultful API规范

 

  • 根据method的不同,做不同的操作

示例: 

@app.route('/order',methods=['GET','POST','PUT','DELETE'])
def order():
    if request.method == 'GET':
        return '获取数据'
    elif request.method == 'POST':
        return '创建数据'
    elif request.method == 'PUT':
        return '更新数据'
    elif request.method == 'DELETE':
        return '删除数据' 

method还有patch 
put 是在服务器更新全部资源 
patch 是在服务器上更新局部资源

  • API与用户的通信协议,总是使用HTTPs协议。 

  • 域名 

子域名方式(解决跨域问题): 
如 
www.huangyongpeng.com 
api.huangyongpeng.com(存在跨域问题) 
url方式: 
如 
www.huangyongpeng.com 
www.huangyongpeng.com/api/ 
这样别人一看到这种url就知道这是一个接口。 

  • 版本 

url: 
www.huangyongpeng.com/api/v1/ 
也可以写在请求头里面(不太明白, 有些是规定要写在请求头里 ,但实际使用却是在url中, 活学活用吧大概是);

  • 面向资源编程

网络上任何东西都是资源,均使用名词表示 
如一开始用的order 
www.huangyongpeng.com/api/v1/order/

  • 过滤,通过在url上传参的形式传递搜索条件 

如: 
www.huangyongpeng/api/v1/order?page=2翻到第二页

  • 状态码 

常用的有以下几个: 


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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

一般可以这样看 

200系列是成功 
300系列是重定向问题 
400系列客服端错误 
500系列服务端错误

但是仅仅靠状态码是不能全部表示数据的状态的,所以在返回时用code和状态码结合。

  • 错误处理,返回错误信息

返回body内容中, 可提示对应msg信息

  • 返回结果,针对不同操作

服务器向用户返回的结果应该符合以下规范 
GET /order/ 
返回资源对象的列表(数组) 
GET /order/1/ 
返回单个资源对象 
POST /order/ 
返回新生成的资源对象 
PUT /order/1/ 
返回完整的资源对象 
PATCH /order/1/ 
返回完整的资源对象 
DELETE /order/1/ 
返回一个空文档

  • Hypermedia API

RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么

resultful其实本质上就是一个规范,定义一些规范让我们写API的时候更好作区分,让后台更好作处理,让我们的前台更好的记住这些url,说白了就是在这个url体现出对这个API的操作。遵循这个规范,就是让大家在协同开发的时候,相互之间更加统一了。 
原来我们没用API之前,我们用的是get,post…全都能实现,但只不过url得保存好多个,学了resultful API之后,才渐渐的去使用,但使用的过程中,也会发现有的能适用,有的不能适用。 

 

本文转载自:https://blog.csdn.net/huang_yong_peng/article/details/82145844

共有 人打赏支持
尾生
粉丝 16
博文 145
码字总数 60686
作品 0
杭州
程序员
私信 提问
加载中

评论(2)

尾生
尾生

引用来自“AmosExe”的评论

Url不应该有版本号,这是不符合这个架构,
严格意义上是不可以, 但从方便测试和可读性来讲,URL中掺加版本号也不是不可以,我看很多实际项目也是这么做的;
AmosExe
AmosExe
Url不应该有版本号,这是不符合这个架构,
jfast 1.1 版本代码已上传至码云

它是一款轻量级 Java Web 框架,基于MVC架构 - 内置 IOC(基于guice)、AOP(基于guice,cglib)、ORM、DAO、MVC 等特性 - 基于 Servlet 3.0 规范 - 使用 Java 注解取代 XML 配置 - 支持jsp,veloc...

it技术宅男
2018/07/12
0
0
如何 通过 Java 实现 elasticsearch 中 各种数据类型的映射 ,主要是数组

如题所示,其实 主要是想把 关键字映射成数组,但是不知道如何映射 通过 Java ,调用其底层 ,而不是 调动其中的resultful 接口

skyyan2000
2016/04/06
1K
3
十万个为什么之什么是SpringBoot

1.什么是springboot 简单的说: spring boot就是整合了spring大家族衍生框架(Spring,SpringMVC...)各优点的一个新框架; a)一种全新的编程规范,简化了框架的使用,去除Spring众多框架中所需的大...

尾生
2018/12/07
0
0
十万个为什么

为什么有耳屎 人的外耳道皮肤具有耵聍腺,分泌一种淡黄色黏稠的物质称为耵聍,俗称“耳屎”或“耳蝉”。这种物质有的遇空气干燥后呈薄片状,有的如黏稠的油脂。平时藏在外耳道内,能保护外耳...

evil_01
2016/05/30
51
0
Spring resultFUL编程

主题:spring mvc RESTful风格开发配置: 第一步: <!-- spring mvc RESTful风格的web.xml配置 --> <servlet> <servlet-name>spingmvc_RESTful</servlet-name> <servlet-class>org.springfra......

LUKE1993
2016/10/11
59
0

没有更多内容

加载失败,请刷新页面

加载更多

uml类图

平时阅读一些远吗分析类文章或是设计应用架构时没少与UML类图打交道。实际上,UML类图中最常用到的元素五分钟就能掌握,下面赶紧来一起认识一下它吧: 一、类的属性的表示方式 在UML类图中,...

asdf08442a
6分钟前
0
0
Linux下执行脚本报错提示invalid option 3: set: -

1、在环境下执行sh报错invalid option 3: set: - 2、于是换成chmod 777 install.sh改执行权限,并且默认使用#!/bin/bash bash: ./install.sh: /bin/bash^M: bad interpreter: No such file ......

noob_chr
6分钟前
0
0
phpstrom2018激活与汉化

phpstrom2018激活与汉化 方法一. 直接用浏览器打开 http://idea.lanyus.com/ (推荐) 点击页面中的“获得注册码”,然后在注册时切换至Activation Code选项,输入获得的注册码一长串字符串,...

万建宁
8分钟前
0
0
Kali Linux NetHunter教程Kali NetHunter支持的设备和ROMs

Kali Linux NetHunter教程Kali NetHunter支持的设备和ROMs NetHunter是一个基于Kali Linux为Nexus设备构建的Android渗透测试平台,其中包括一些特殊和独特的功能。NetHunter支持无线802.11注...

大学霸
17分钟前
1
0
端口可用性探测

在服务器上打开了一个端口,我们需要测试是否开启成功是否可用,可以在本机使用 traceroute (linux)工具 traceroute 是几乎所有 Linux 发行版本预装的网络测试工具,用于跟踪 Internet 协议(...

applepaihs
17分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部