REST架构简介

restful简介

在如今web开发纵横的时代,几乎处处可见web页面,每个人都有自己的设计风格,这也导致了web接口五花八门,可能一个增删改查就要对应4个不同的url,这是非常浪费资源,于是Fielding就说,你们这些菜鸡,让我来制定一个规范,大家都统一遵循这个规范,于是REST架构就产生了

REST(Representational State Transfer)

资源

所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URL（统一资源定位符）指向它，每种资源对应一个特定的URL。要获取这个资源，访问它的URL就可以，URI是给我们的资源进行标识的，URL是描述我们资源地址的

表述

比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现

状态转换

访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

总结

• 任何一个可访问的都表示资源
• 每个url代表一个资源
• 客户端通过http对服务端进行操作
• 客户端和服务器通过某种关系,达到资源的传送

RESTful

如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。

一种软件的架构风格，设计风格, 为客户端和服务端的交互提供一组设计原则和约束条件。

restful规范

一.协议

尽量使用https协议

https:www.baidu.com

二.API

在URL中体现api

https:www.myweb.com/api/myclass

三.版本

在url中体现版本

https://www.google.com/v1/xxx

四.操作资源以http请求方式为准

GET/POST/PUT/DELETE/PATCH

五.面向对象资源

每个url代表一种资源,不要用动词,尽量用复数名词

六.在url中筛选条件

https://www.google.com/v1/mycss?page=3

七.返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范

• GET /collection：返回资源对象的列表（数组）
• GET /collection/resource：返回单个资源对象
• POST /collection：返回新生成的资源对象
• PUT /collection/resource：返回完整的资源对象
• PATCH /collection/resource：返回完整的资源对象
• DELETE /collection/resource：返回一个空文档

八.错误处理

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

九.状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

十.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

https://www.cnblogs.com/GGGG-XXXX/articles/9258310.html