1.動詞 + 賓語
RESTful 的核心思想就是,客戶端發出的數據操作指令都是"動詞 + 賓語"的結構。比如,GET /articles
這個命令,GET
是動詞,/articles
是賓語。
動詞通常就是五種 HTTP 方法,對應 CRUD 操作。
GET:讀取(Read)
POST:新建(Create)
PUT:更新(Update)
PATCH:更新(Update),通常是部分更新
DELETE:刪除(Delete)
根據 HTTP 規範,動詞一律大寫。
2.賓語必須是名詞
賓語就是 API 的 URL,是 HTTP 動詞作用的對象。它應該是名詞,不能是動詞。比如,/articles
這個 URL 就是正確的,而下面的 URL 不是名詞,所以都是錯誤的。
getAllCars
/createNewCar
/deleteAllRedCars
3.這沒有統一的規定,但是常見的操作是讀取一個集合,比如GET /articles
(讀取所有文章),這裏明顯應該是複數。
4.避免多級 URL,如
GET /authors/12/categories/2
GET /articles/published
更好的做法是,除了第一級,其他級別都用查詢字符串表達
GET /authors/12?categories=2
GET /articles?published=true