API的就是程序員的UI殷绍,和其他UI一樣,你必須仔細(xì)考慮它的用戶體驗渠羞!
Restful只是web api/Json傳輸接口通過http調(diào)斤贰,取到還要自己解。Rpc一般都是配套的次询,客戶端直接像調(diào)本地函數(shù)一樣調(diào)用(一般用在內(nèi)網(wǎng)服務(wù)間調(diào)用荧恍,可以用rpc的框架thrift)
Swagger可以用來管理你的RESTful API
使用SSL(https)來提供URL
- 使用https可以在數(shù)據(jù)包被抓取時多一層加密
- 即使你使用了https,黑客抓不到你具體傳輸?shù)臄?shù)據(jù)屯吊,但是可以抓到你請求的URL八脱病!因此盒卸,使用https進(jìn)行請求時骗爆,要采用POST、PUT或者HEAD的方式傳輸必要的數(shù)據(jù)
使用GET蔽介、POST摘投、PUT、DELETE這幾種請求模式
- curl請求支持這些請求方式
- get(select)從服務(wù)器抽取資源虹蓄;
- post(create)在服務(wù)器創(chuàng)建一個資源犀呼;
- put(update)在服務(wù)器更新資源;
- delete(delete)從服務(wù)器刪除資源薇组。
在URI中體現(xiàn)資源外臂,而非動作
- 每個網(wǎng)址代表一種資源,不能用動詞只能有名詞律胀,多用復(fù)數(shù)名詞
- URI的設(shè)計應(yīng)該遵循可尋址性原則宋光,具有自描述性,需要在形式上給人以直覺上的關(guān)聯(lián)
- 使用?用來過濾資源炭菌,很多人只是把?簡單的當(dāng)做是參數(shù)的傳遞罪佳,很容易造成URI過于復(fù)雜、難以理解黑低。赘艳?對應(yīng)的是一些特定條件的查詢結(jié)果或算法運(yùn)算結(jié)果。
- ,或;可以用來表示同級資源的關(guān)系投储,有時候我們需要表示同級資源的關(guān)系時第练,可以使用,或;來進(jìn)行分割阔馋。
版本
- 接口參數(shù)或返回值有變化
- 邏輯處理有變化
HTTP響應(yīng)碼
下面是一些參考的狀態(tài)碼:
- 200 OK - [GET]:服務(wù)器成功返回用戶請求的數(shù)據(jù)玛荞,該操作是冪等的(Idempotent)。
- 201 CREATED - [POST/PUT/PATCH]:用戶新建或修改數(shù)據(jù)成功呕寝。
- 202 Accepted - [*]:表示一個請求已經(jīng)進(jìn)入后臺排隊(異步任務(wù))
- 204 NO CONTENT - [DELETE]:用戶刪除數(shù)據(jù)成功勋眯。
- 400 INVALID REQUEST - [POST/PUT/PATCH]:用戶發(fā)出的請求有錯誤,服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作,該操作是冪等的客蹋。
- 401 Unauthorized - [*]:表示用戶沒有權(quán)限(令牌塞蹭、用戶名、密碼錯誤)讶坯。
- 403 Forbidden - [*] 表示用戶得到授權(quán)(與401錯誤相對)番电,但是訪問是被禁止的。
- 404 NOT FOUND - [*]:用戶發(fā)出的請求針對的是不存在的記錄辆琅,服務(wù)器沒有進(jìn)行操作漱办,該操作是冪等的。
- 406 Not Acceptable - [GET]:用戶請求的格式不可得(比如用戶請求JSON格式婉烟,但是只有XML格式)娩井。
- 410 Gone -[GET]:用戶請求的資源被永久刪除,且不會再得到的似袁。
- 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個對象時洞辣,發(fā)生一個驗證錯誤。
- 500 INTERNAL SERVER ERROR - [*]:服務(wù)器發(fā)生錯誤昙衅,用戶將無法判斷發(fā)出的請求是否成功扬霜。
返回值結(jié)構(gòu)
使用JSON進(jìn)行返回:
JSON可以很好的被很多程序支持,javascript的ajax可以直接將JSON轉(zhuǎn)換為對象绒尊。
JSON的格式在容量上比xml小很多畜挥,可以減低寬帶占用,提高傳輸效率婴谱。
-
字段的合理返回蟹但,數(shù)據(jù)的包裹。因為返回值中谭羔,我們常常要對數(shù)據(jù)進(jìn)行區(qū)分分組华糖,或者按照從屬關(guān)系打包,所以瘟裸,我們再返回時客叉,最好有包裹的思想,把數(shù)據(jù)存放在不同的包裹中進(jìn)行返回话告。
{ "error_code" : , "data" : { "user_id" : , "username" : "admin" }, "server_time": 14939939 }
鑒權(quán)
- 通行的是使用OAuth的方式兼搏,通過AccessToken來進(jìn)行身份管理
自我保護(hù)能力
- 即使使用的人沒仔細(xì)看API文檔隨便亂用也不會導(dǎo)致系統(tǒng)出問題,這種案例非常的多沙郭,例如對外提供了一個批量查詢接口佛呻,結(jié)果用戶一下傳了一個里面有上千個用戶id的數(shù)組,查詢一下直接把內(nèi)存耗光病线,像這種情況下不能怪使用的人吓著,而應(yīng)該怪實現(xiàn)API的這一端的保護(hù)做的不夠好鲤嫡,按照這樣的標(biāo)準(zhǔn)去看,會發(fā)現(xiàn)開源的很多東西的API都不太合格绑莺;