美文网首页
restful简介与风格设计

restful简介与风格设计

作者: Trouble_Ma | 来源:发表于2018-10-16 19:04 被阅读0次

restful:是一种架构风格,是一种理论框架,可以让项目更简单/更清晰.

restful框架关心的有:
资源:
所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符uniform resource identifier)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。
表现层:
"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。
比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。

URI只代表资源的实体,不代表它的格式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。
{"id":"1" ,"name":"sky"}
127.0.0.1:80/getUserInfo.json
状态转移:
访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。

让服务器端发生"状态转化"(State Transfer)。安照REST的规定,资源的状态转化不能体现在URI上面。
示例:删除一个用户:
之前的做法:http://127.0.0.1:80/user_del?id=1
restful做法:http://127.0.0.1:80/user/1 Del请求
状态转换的东西不应该体现在URI上,而应该使用统一接口进行传递
统一接口:
REST要求,必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

以HTTP1.1协议为例
有七个接口:
GET / POST / PUT / DELETE / PATCH / HEAD / OPTIONS
HTTP头信息(可自定义)
HTTP响应状态代码(可自定义)
这些就是HTTP1.1协议提供的统一接口

按照restful风格设计主要关心:
资源设计:
主要涉及资源设计,也就是URI的设计.
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。

动作设计:
HTTP动作设计:
GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性【补丁】)。
DELETE(DELETE):从服务器删除资源。

HEAD:获得一个资源的元数据,比如一个资源的hash值或者最后修改日期;
OPTIONS:获得客户针对一个资源能够实施的操作;

动作示例:
GET /zoos:列出所有动物园
POST /zoos:新建一个动物园
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

返回结果设计:
返回结果:(一般不遵守此设计)
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

Accept:
restful:是一种架构风格,是一种理论框架,可以让项目更简单/更清晰.

restful框架关心的有:
资源:
所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符uniform resource identifier)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。
表现层:
"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。
比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。

URI只代表资源的实体,不代表它的格式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。
{"id":"1" ,"name":"sky"}
127.0.0.1:80/getUserInfo.json
状态转移:
访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。

让服务器端发生"状态转化"(State Transfer)。安照REST的规定,资源的状态转化不能体现在URI上面。
示例:删除一个用户:
之前的做法:http://127.0.0.1:80/user_del?id=1
restful做法:http://127.0.0.1:80/user/1 Del请求
状态转换的东西不应该体现在URI上,而应该使用统一接口进行传递
统一接口:
REST要求,必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

以HTTP1.1协议为例
有七个接口:
GET / POST / PUT / DELETE / PATCH / HEAD / OPTIONS
HTTP头信息(可自定义)
HTTP响应状态代码(可自定义)
这些就是HTTP1.1协议提供的统一接口

按照restful风格设计主要关心:
资源设计:
主要涉及资源设计,也就是URI的设计.
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。

动作设计:
HTTP动作设计:
GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性【补丁】)。
DELETE(DELETE):从服务器删除资源。

HEAD:获得一个资源的元数据,比如一个资源的hash值或者最后修改日期;
OPTIONS:获得客户针对一个资源能够实施的操作;

动作示例:
GET /zoos:列出所有动物园
POST /zoos:新建一个动物园
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

返回结果设计:
返回结果:(一般不遵守此设计)
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

Accept:
1,一个API可以允许返回JSON,Xml甚至HTML等文档格式;建议使用json;
2,可以通过URL来规定获取得格式类型,比如https://api.example.com/v1/employee/1.json等;但是更建议使用Accept这个请求头;
Accept="application/json"

常见状态码:
200 OK - [GET]:服务器成功返回用户请求的数据。
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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

相关文章

  • restful简介与风格设计

    restful:是一种架构风格,是一种理论框架,可以让项目更简单/更清晰. restful框架关心的有:资源:所谓...

  • RESTful架构和API设计

    理解RESTful风格 - 阮一峰RESTful设计风格指南 - 阮一峰RESTful 风格api 优点: 将接口...

  • 接口架构-Restful风格

    RESTful是一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。RESTful风格规范了...

  • RESTFul设计风格(三)

    往期回顾: 请君入坑:RESTFul设计风格(一) 请君入坑:RESTFul设计风格(二) 最近几年,前后端分离特...

  • RESTful API

    RESTful API 一、RESTful简介 1.Restful是什么 本质:一种软件架构风格核心:面向资源解决...

  • RESTful风格api

    restful 是一种架构风格、设计风格。而并非标准。 RESTful原本名称叫做 representation...

  • WebServiceCXF与Restful架构风格简介

    什么是WebService 简单的说,WebService是一种多系统之间通信的技术. WebService是一个...

  • DRF使用篇(一):什么是restful

    什么是restful RESTful是一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它...

  • RESTful设计风格

    get 获取post 新建put 更改(提供全部信息)DELETE 删除patch 更改(提供部分信息) R...

  • RESTful设计风格

    REST模式与复杂的SOAP和XML-RPC相比更加简洁,越来越多的web服务开始采用REST风格设计和实现RES...

网友评论

      本文标题:restful简介与风格设计

      本文链接:https://www.haomeiwen.com/subject/vbxkzftx.html