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

起源

愈来愈多的人开始意识到，网站即软件，并且是一种新型的软件。这种"互联网软件"采用客户端/服务器模式，创建在分布式体系上，经过互联网通讯，具备高延时（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以后，才渐渐的去使用，但使用的过程当中，也会发现有的能适用，有的不能适用。