RESTful设计原则和样例（开发前后台接口）

Posted 2020-09-28 超越梦想

摘要

REST（表征性状态传输）设计风格;REST通常基于使用HTTP，URI协议和标准。使用URL标识资源，开发前后台接口。主要使用post，get方式

参考博文： http://www.cnblogs.com/artech/p/restful-web-api-02.html    

维基百科：https://zh.wikipedia.org/wiki/REST

目前在三种主流的Web服务实现方案中，因为REST模式与复杂的SOAP和XML-RPC相比更加简洁，越来越多的web服务开始采用REST风格设计和实现。例如，Amazon.com提供接近REST风格的Web服务进行图书查找；雅虎提供的Web服务也是REST风格的。

 

要点及标准

 

需要注意的是，REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML以及HTML这些现有的广泛流行的协议和标准。

• 资源是由URI来指定。

• 对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。

• 通过操作资源的表现形式来操作资源。

• 资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式。

REST的要求

• 客户端和服务器结构

• 连接协议具有无状态性

• 能够利用Cache机制增进性能

• 层次化的系统

• 所需代码 - JavaScript （可选）

关于状态

应该注意区别应用的状态和连接协议的状态。HTTP连接是无状态的（也就是不记录每个连接的信息），而REST传输会包含应用的所有状态信息，因此可以大幅降低对HTTP连接的重复请求资源消耗。

应用于 Web 服务

符合 REST 设计风格的 Web API 称为 RESTful API。它从以下三个方面资源进行定义：

• 直观简短的资源地址：URI，比如：http://example.com/resources/。

• 传输的资源：Web服务接受与返回的互联网媒体类型，比如：JSON，XML ，YAML 等。

• 对资源的操作：Web服务在该资源上所支持的一系列请求方法（比如：POST，GET，PUT或DELETE）。

下表列出了在实现 RESTful API 时 HTTP 请求方法的典型用途。

^[1] HTTP 请求方法在 RESTful API 中的典型应用

资源	GET	PUT	POST	DELETE
一组资源的URI，比如http://example.com/resources/	列出 URI，以及该资源组中每个资源的详细信息（后者可选）。	使用给定的一组资源替换当前整组资源。	在本组资源中创建/追加一个新的资源。 该操作往往返回新资源的URL。	删除 整组资源。
单个资源的URI，比如http://example.com/resources/142	获取 指定的资源的详细信息，格式可以自选一个合适的网络媒体类型（比如：XML、JSON等）	替换/创建 指定的资源。并将其追加到相应的资源组中。	把指定的资源当做一个资源组，并在其下创建/追加一个新的元素，使其隶属于当前资源。	删除 指定的元素。

PUT 和 DELETE 方法是幂等方法。GET方法是安全方法 （不会对服务器端有修改，因此当然也是幂等的）。

不像基于SOAP的Web服务，RESTful Web服务并没有的“正式”标准^[2]。 这是因为REST是一种架构，而SOAP只是一个协议。虽然REST不是一个标准，但在实现RESTful Web服务时可以使用其他各种标准（比如HTTP，URL，XML，PNG等）。

实现举例[编辑]

例如，一个简单的网络商店应用，

列举所有商品，

GET http://www.store.com/products

呈现某一件商品，

GET http://www.store.com/product/12345

下单购买，

POST http://www.store.com/order
<purchase-order>
  <item> ... </item1>
</purchase-order>

REST的优点

• 可更高效利用缓存来提高响应速度

• 通讯本身的无状态性可以让不同的服务器的处理一系列请求中的不同请求，提高服务器的扩展性

• 浏览器即可作为客户端，简化软件需求

• 相对于其他叠加在HTTP协议之上的机制，REST的软件依赖性更小

• 不需要额外的资源发现机制

• 在软件技术演进中的长期的兼容性更好

默认所有输入输出均为JSON格式。一个例外：GET请求的参数为URL参数
出错代码一律使用HTTP标准错误码，参见HTTP 标准状态码

修改用户：

    URL: POST /mm/v1/crm/customer/[customer id]
输入：
参数名 参数类型 说明 必填 默认值 限制
name string 客户名称 是   
interface_person string 对接人姓名 是   
interface_phonenumber string 对接人电话 是   
interface_email string 对接人邮箱 是   

输出：
参数名 参数类型 说明 样例值
id int 客户ID 10001
name string 客户名称 银行
interface_person string 对接人姓名 小明
interface_phonenumber string 对接人电话 12345678
interface_email string 对接人邮箱 [e-mail]
create_time date 客户创建时间 2015-04-01 12:34:56

获得所有可编辑权限
URL: GET /mm/v1/crm/permission
输入
输出
一个数组。每个元素代表一个可编辑的权限项，格式如下
参数名 参数类型 说明 样例值
id int 权限ID 1
name string 权限名称 DEMO APP

删除用户

URL：DELETE /mm/v1/crm/customer/[customer id]
输入：无
输出：
参数名     参数类型     说明                 样例值
id             int      成功删除的客户ID     10001