rest api介面規範
阿新 • • 發佈:2018-11-26
1.設計規範
1.協議:使用HTTPs協議 確保互動資料的傳輸安全
2.域名:儘量將api部署在專用域名下https://api.example.com
3.版本控制:將版本號放在url中或者header中 v1,v2,vn
4.路徑:只能包含名詞,
5.過濾資訊:?limit=10 ?offset=10 ?page=1 ?sortby=name
6.Hypermedia Api:在返回結果中提供相關資源的連線,連向其他Api方法
7.驗證:確定使用者是其宣告的身份,比如提供賬戶的密碼
8.授權:保證使用者有對資源特定操作的許可權。比如使用者私人資訊只能自己能夠訪問,其他人無法看到,有些特殊的操作只能管理員可以操作,其他使用者有隻讀的許可權等
9.狀態碼:
200 現有資源已被更改
201 如果新資源被建立
202 已接受處理請求但尚未完成
301 資源的url被更新
303 如負載均衡
400 指代壞請求
404 資源不存在
406 服務端不支援所需要表示
409 通用衝突
412 前置條件失敗
415 接受到的表示不受支援
500 通用錯誤響應
503 服務當前無法處理請求
10.介面例項