BE - 唠叨下 Restful 与 RPC-JSON 基于HTTP的API接口设计

本篇文章不涉及 XML 接口数据内容 : rpc-xml

啰嗦

最近在写关于restful相关接口，学习之后，发现与之前所了解到的接口不大一样。从接触移动开发以来均是rpc-json方式进行开发，比如：

// request
POST /sayHello HTTP/1.1
HOST: api.example.com
Content-Type: application/json
{"name":"Yuan"}

// response
{    
    "code":0,
    "msg":"success",
    "data": "Hello Yuan"
}

之前还以为 restful 就是这种的接口方式，而并没有具体的去深入过这块内容，还以为接口开发不就是这样的吗？ 其实这种是rpc-json的api设计，不过不是规范的rpc-json的api设计，应该说是rpc-json演变过来的api设计。

之前还给 学弟学妹培训过 接口设计（rpc-json）：

App接口开发课程讲解和总结

不过在 学习 springmvc相关知识的时候，总结中的restful就理解错了：

Spring MVC - 上傳圖片, JSON数据交互 ,RESTful 支持

因为restful这个名词后边才知晓，所以就想当然的理解为了rpc-json的api设计。下面就说说 restful 和 rpc-json的 api接口设计。

RPC - JSON

JSON-RPC 中文版规范

无状态且轻量级的远程过程调用（RPC）协议 ， 它允许在基于http, socket 等不同消息传输环境的同一进程中，使用json作为数据格式。

好吧，读完也不知道什么玩意，‘同一进程’才是懵逼，使用json作为数据格式还可以看懂。

先看看我在接触过的接口api数据格式：

第一种：

// request
POST /work/addComment HTTP/1.1
HOST: api.example.com
Content-Type: application/json
{
   "work_id": 1，
   "conent":"Hello Yuan"，
   "type":1
}

// response
{    
    "code":0,
    "msg":"success",
    "data":{}
}

第二种： 据说聚美的就是这样的哦

只有host地址 ， 所有操作全部访问host即可，略显霸气 .

// request
HOST: api.example.com
Content-Type: application/json
{
   "s": "Hello"， //后台对应接口 service name : HelloService
   "m": "sayHello"，//即service下method name: HelloService#sayHello
   "p": ['Yuan']， // 参数：按规定顺序放入数组中，没有空数组非null
   "o": "android"， // 请求客户端的操作系统
   "v": "1.0.0"，  // versionName 版本号
   "a": "sdssdsdsdxs" // 可有可没有，加密签名认证用的
}

//response
{    
    "code":0, //成功全部是 0
    "msg":"success",
    "data": "Hello Yuan"
}

这两种均是类 rpc-json的 在上面的文章中，发送一个请求对象至服务端代表一个rpc调用，需要包含下面内容：

• method
• params
• id
• jsonrpc

而响应对象 回应，就大同小异了，rpc-json中的响应对象包含：

• jsonrpc
• result
• error
  
  • code
  • message
  • data
• id

通过对比，上面的第二种方式，更接近于 rpc-json方式，而第一种方式是响应数据类似rpc-json，请求数据类似 restful .

---

Restful

RESTful API 设计指南

阮老师写的已经很明白不过了，自己看吧，我摘抄下：

http

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：删除某个指定动物园的指定动物

filter

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

code

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

error

{
    error: "Invalid API key"
}

result

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

---

Restful 与 RPC-JSON对比

（1）行为

rpc-json ： api 适用于动作，过程，命令等
restful : api 适用于资源或实体，基于数据的CRUD操作

比如： 发送消息

rpc-json

POST /sendMessage HTTP/1.1
Host: api.example.com
Content-Type: application/json
{"userId": 110, "message": "Hello!"}

restful

POST /users/110/messages HTTP/1.1
Host: api.example.com
Content-Type: application/json
{"message": "Hello!"}

（2）词性

rpc-json 通常指定某个动作，一般为动词，比如 getUserInfoById(id)
restful 通常指定资源，一般为名词，比如 user/:id

---

最后

接口设计

只要遵循restful和rpc-json规则，在接口设计上可以同时使用restful 和rpc-json。如果在某个接口上使用restful更快捷，那就使用restful的；如果在某个接口上使用rpc-json更合适，就使用rpc-json方式。