rest api接口規范


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  指用戶發送的錯誤請求

    401  用戶沒有權限

    403  訪問禁止

    404  資源不存在

    406  服務端不支持所需要表示

    409  通用沖突

    412  前置條件失敗

    415   接受到的表示不受支持

    500  通用錯誤響應

    503  服務當前無法處理請求

  10.接口實例

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM