風(fēng)格
POST
協(xié)議
+ 域名/IP
+ 端口號(hào)
+ /api
+ /項(xiàng)目名
+ /一級(jí)資源
+ /n級(jí)資源
+ 動(dòng)作
如:http://127.0.0.1:6666/api/user/detail/get
RESTful
協(xié)議
+ 域名/IP
+ 端口號(hào)
+ /api
+ /項(xiàng)目名
+ /一級(jí)資源
+ /n級(jí)資源
如:GET
http://127.0.0.1:6666/api/user/detail
URL參數(shù)
統(tǒng)一使用 &
連接鍵值對(duì)的方式
如:http://127.0.0.1:6666/api/user/get?name_user=Tony&sex_user=1
方法 | 描述 |
---|---|
HEAD | 可以對(duì)任何資源發(fā)出請(qǐng)求针饥,以獲取HTTP頭信息 |
GET | 查找資源 |
POST | 創(chuàng)建資源 |
PATCH | 替換資源的部分信息 |
PUT | 替換資源的全部信息厂抽,要求請(qǐng)求信息是完整的。若某字段不傳遞丁眼,則賦予默認(rèn)值 |
DELETE | 刪除資源 |
注意點(diǎn)
版本號(hào)不應(yīng)寫在URL中
不同版本筷凤,可以理解成同一種資源的不同表現(xiàn)形式,所以應(yīng)該采用同一個(gè)URL苞七。版本號(hào)可以在HTTP請(qǐng)求頭信息的 Accept
字段中進(jìn)行區(qū)分
Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
RESTful URL 只出現(xiàn)名詞
如果某些動(dòng)作是HTTP動(dòng)詞表示不了的藐守,你就應(yīng)該把動(dòng)作做成一種資源。比如網(wǎng)上匯款蹂风,從賬戶1向賬戶2匯款500元卢厂,錯(cuò)誤的URI是:
POST /accounts/1/transfer/500/to/2
正確的寫法是把動(dòng)詞transfer改成名詞transaction,資源不能是動(dòng)詞惠啄,但是可以是一種服務(wù):
POST /transaction