Restful规范

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

 

发布了57 篇原创文章 · 获赞 7 · 访问量 5079
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章