RESTFUL風格的接口命名規范


1.首先restfulf風格的api是基於資源的,url命名用來定位資源,而不是表示動作,動作通過請求方式進行表示。

2.URL中應該單復數區分,推薦的實踐是永遠只用復數。比如GET /api/users表示獲取用戶的列表,如果獲取單個資源,傳入ID,比如/api/users/123,表示獲取單個用戶的信息。

3.修改的方法可以用PUT和PATCH表示,PUT 用於更新資源的全部信息,在請求的 body 中需要傳入修改后的全部資源主體,PATCH 用於局部更新,在 body 中只需要傳入需要改動的資源字段。如果一個資源有很多字段,在進行局部更新時,只需要傳入需要修改的字段即可,否則在用 PUT 的情況下,你不得不將整個資源模型全都發送回服務器,造成網絡資源的極大浪費。

4.URI結尾不應包含(/)

5.正斜杠分隔符(/)必須用來指示層級關系

6.應使用連字符( - )來提高URI的可讀性

7.不得在URI中使用下划線(_)

8.URI路徑中全都使用小寫字母

9.規范示例如下:

  GET /api/users  獲取用戶的列表

  GET /api/users/123  獲取id為123的用戶信息


免責聲明!

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



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