一 、 概述
1、動詞 + 賓語
RESTful 的核心思想就是，客戶端發(fā)出的數(shù)據(jù)操作指令都是"動詞 + 賓語"的結(jié)構(gòu)。比如，GET /materials這個命令，GET是動詞，/materials是賓語。
動詞通常就是五種 HTTP 方法，對應(yīng) CRUD 操作。
- GET：讀取（Read）
- POST：新建（Create）
- PUT：更新（Update）
- DELETE：刪除（Delete）
2、 賓語必須是名詞
賓語就是 API 的 URL，是 HTTP 動詞作用的對象。它應(yīng)該是名詞，不能是動詞。比如，/materials這個 URL 就是正確的，而下面的 URL 不是名詞，所以都是錯誤的。
- /getAllCars
- /createNewCar
- /deleteAllRedCars
3、 復(fù)數(shù) URL
這沒有統(tǒng)一的規(guī)定，但是常見的操作是讀取一個集合，比如GET /materials（讀取所有材料），這里明顯應(yīng)該是復(fù)數(shù)。
為了統(tǒng)一起見，建議都使用復(fù)數(shù) URL，比如GET /materials要好于 GET /materials
二、 樣例
1、獲取材料信息列表
GET /materials/
2、根據(jù)材料主鍵獲取材料
GET /materials/{materialId}
3、根據(jù)材料類型主鍵獲取材料信息
GET /materials/
參數(shù)類型：form-data
參數(shù)：sortId
4、保存材料信息
POST /materials/
參數(shù)類型：raw: application/json
參數(shù)(json串)：
{
"key1":value1,
"key2":value2
}
5、根據(jù)材料主鍵更新材料信息
PUT /materials/{materialId}
參數(shù)類型：raw: application/json
參數(shù)(json串)：
{
"key1":value1,
"key2":value2
}
6、根據(jù)材料類型主鍵更新材料信息
PUT /materials/
參數(shù)類型：raw: application/json
參數(shù)(json串)：
{
"sortId":"001"
}
7、根據(jù)材料主鍵刪除材料信息
DELETE /materials/{materialId}
8、根據(jù)材料類型主鍵更新材料信息
DELETE /materials/
參數(shù)類型：raw: application/json
參數(shù)(json串)：
{
"sortId":"001"
}
