RESTful格式規範
阿新 • • 發佈:2019-01-10
RESTful是介面開發格式裡面很重要的一個山頭,基本開發介面都需要遵守這個規範,它共有十條規範格式:
1、域名,一般將api放在組域名下
http://www.example.com/api/
2、版本,一般把介面的版本號放在url中
http://www.example.com/app/1.0/info
http://www.example.com/app/1.2/info
3、路徑,路徑表示api的具體網址,網址代表一種資源,網址中不能使用動詞,只能使用名詞,而其必須是複數
#獲取單個商品
http://www.example.com/app/goods/1
#獲取所有商品
http://www.example.com/app/goods
4、使用標準的Http方法,由HTTP動詞組成
GET SELECT :從伺服器獲取資源。
POST CREATE :在伺服器新建資源。
PUT UPDATE :在伺服器更新資源。
DELETE DELETE :從伺服器刪除資源。
5、過濾資訊,如果資源資料較多,伺服器不能將所有資料一次全部返回給客戶端。API應該提供引數,過濾返回結果
#指定返回資料的數量
http://www.example.com/goods?limit=10
#指定返回資料的開始位置
http://www.example.com/goods?offset=10
#指定第幾頁,以及每頁資料的數量
http://www.example.com/goods?page=2&per_page=20
6、狀態碼
7、錯誤資訊,一般來說,伺服器返回的錯誤資訊,以鍵值對的形式返回。
8、響應結果
#返回商品列表
GET http://www.example.com/goods
#返回單個商品
GET http://www.example.com/goods/cup
#返回新生成的商品
POST http://www.example.com/goods
#返回一個空文件
DELETE http://www.example.com/goods
9、使用連結連結相關資源,在返回響應結果時提供連結其他API的方法,使客戶端很方便的獲取相關聯的資訊。
10、伺服器返回的資料格式,應該儘量使用JSON,避免使用XML。