word版可編輯-restfulapi設(shè)計規(guī)范精心整理-資料下載頁
2025-04-07 06:53本頁面
【正文】 法發(fā)送普通的credential。這種情況下可以在查詢url中添加參數(shù)：access_token。注意使用url參數(shù)的問題是：目前大部分的網(wǎng)絡(luò)服務(wù)器都會講query參數(shù)保存到服務(wù)器日志中，這可能會成為大的安全風(fēng)險。注意上面說到的只是三種傳輸token的方法，實際傳輸?shù)膖oken可能是一樣的。緩存HTTP提供了自帶的緩存框架。你需要做的是在返回的時候加入一些返回頭信息，在接受輸入的時候加入輸入驗證?；緝煞N方法：ETag：當(dāng)生成請求的時候，在HTTP頭里面加入ETag，其中包含請求的校驗和和哈希值，這個值和在輸入變化的時候也應(yīng)該變化。如果輸入的HTTP請求包含IFNONEMATCH頭以及一個ETag值，那么API應(yīng)該返回304 not modified狀態(tài)碼，而不是常規(guī)的輸出結(jié)果。LastModified：和etag一樣，只是多了一個時間戳。返回頭里的LastModified：包含了RFC 1123時間戳，它和IFMODIFIEDSINCE一致。HTTP規(guī)范里面有三種date格式，服務(wù)器應(yīng)該都能處理。出錯處理就像html錯誤頁面能夠顯示錯誤信息一樣，API 也應(yīng)該能返回可讀的錯誤信息–它應(yīng)該和一般的資源格式一致。API應(yīng)該始終返回相應(yīng)的狀態(tài)碼，以反映服務(wù)器或者請求的狀態(tài)。API的錯誤碼可以分為兩部分，400系列和500系列，400系列表明客戶端錯誤：如錯誤的請求格式等。500系列表示服務(wù)器錯誤。API應(yīng)該至少將所有的400系列的錯誤以json形式返回。如果可能500系列的錯誤也應(yīng)該如此。json格式的錯誤應(yīng)該包含以下信息：一個有用的錯誤信息，一個唯一的錯誤碼，以及任何可能的詳細(xì)錯誤描述。如下：12345{code : 1234,message : Something bad happened :(,description : More details about the error here}對PUT,POST,PATCH的輸入的校驗也應(yīng)該返回相應(yīng)的錯誤信息，例如：12345678910111213141516{code : 1024,message : Validation Failed,errors : [{code : 5432,field : first_name,message : First name cannot have fancy characters},{code : 5622,field : password,message : Password cannot be blank}]}HTTP 狀態(tài)碼123456789101112200 ok 成功返回狀態(tài)，對應(yīng)，GET,PUT,PATCH,DELETE.201 created成功創(chuàng)建。304 not modified HTTP緩存有效。400 bad request 請求格式錯誤。401 unauthorized 未授權(quán)。403 forbidden 鑒權(quán)成功，但是該用戶沒有權(quán)限。404 not found 請求的資源不存在405 method not allowed 該方法不被允許。410 gone 這個url對應(yīng)的資源現(xiàn)在不可用。415 unsupported media type 請求類型錯誤。422 unprocessable entity 校驗錯誤時用。429 too many request 請求過多。
公司管理相關(guān)推薦
鄂ICP備17016276號-1