简体字、冯|restful 风格url

一 、 概述

1、动词 + 宾语

RESTful 的核心思想就是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如，GET /materials这个命令，GET是动词，/materials是宾语。

动词通常就是五种 HTTP 方法，对应 CRUD 操作。

• GET：读取（Read）
• POST：新建（Create）
• PUT：更新（Update）
• DELETE：删除（Delete）

2、 宾语必须是名词

宾语就是 API 的 URL，是 HTTP 动词作用的对象。它应该是名词，不能是动词。比如，/materials这个 URL 就是正确的，而下面的 URL 不是名词，所以都是错误的。

• /getAllCars
• /createNewCar
• /deleteAllRedCars

3、 复数 URL

这没有统一的规定，但是常见的操作是读取一个集合，比如GET /materials（读取所有材料），这里明显应该是复数。

为了统一起见，建议都使用复数 URL，比如GET /materials要好于 GET /materials

二、 样例

1、获取材料信息列表

GET /materials/

2、根据材料主键获取材料

GET /materials/{materialId}

3、根据材料类型主键获取材料信息

GET /materials/

参数类型：form-data

参数：sortId

4、保存材料信息

POST /materials/

参数类型：raw: application/json

参数(json串)：

{
"key1":value1,
"key2":value2
}

5、根据材料主键更新材料信息

PUT /materials/{materialId}

参数类型：raw: application/json

参数(json串)：

{
"key1":value1,
"key2":value2
}

6、根据材料类型主键更新材料信息

PUT /materials/
参数类型：raw: application/json

参数(json串)：

{
"sortId":"001"
}

7、根据材料主键删除材料信息

DELETE /materials/{materialId}

8、根据材料类型主键更新材料信息

DELETE /materials/

参数类型：raw: application/json

参数(json串)：

{
"sortId":"001"
}