一 什么是REST
REST指Representational State Transfer,意思是表述性狀態(tài)轉(zhuǎn)移。其是一種架構(gòu)規(guī)范,符合REST規(guī)范的Api設(shè)計(jì)稱為RESTful Api。
何為表述性狀態(tài)轉(zhuǎn)移?
- 表述性:
指資源的表示形式,例如json、xml格式等。 - 狀態(tài)轉(zhuǎn)移:
描述服務(wù)器端資源的改變狀態(tài),利用通過增刪改查導(dǎo)致的變化。 -
結(jié)論:
結(jié)合以上兩點(diǎn),表述性狀態(tài)轉(zhuǎn)移指的是客戶端通過對服務(wù)器的增刪改查而導(dǎo)致的表述性資源的狀態(tài)轉(zhuǎn)移。
二 接口設(shè)計(jì)規(guī)范
- 命名規(guī)范:
Url中使用名詞復(fù)數(shù),不能出現(xiàn)動(dòng)詞。 - 請求方法規(guī)范:
- GET:從服務(wù)器獲取指定資源。
- POST:在服務(wù)器上創(chuàng)建一個(gè)新資源。
- PUT:更新服務(wù)器資源。
- DELETE:從服務(wù)器刪除指定資源。
-
狀態(tài)碼:
狀態(tài)碼
三 例子
- 通過id獲取用戶的信息
GET /users/userId
反例:
GET /users/getUserById - 通過id更新用戶的信息
PUT /users/userId
反例:
POST /users/updateUserById
