RESTFUL風格的介面命名規範

2022-09-04 18:30:14 字數 579 閱讀 9764

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的使用者資訊

restful風格的介面

api與使用者的通訊協議,總是使用https協議。應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下。應該將api的版本號放入url。v1 另一種做法是,將版本號放在http頭資訊中,但不如放入url方便和直觀。github採用這種做法。路徑...

介面測試 RESTful風格介面

restful架構是一種介面設計架構風格,而不是標準,只是提供了一組設計原則。http 為我們http協議的訪問頭標準 埠號 為我們伺服器內專案訪問的指定編號 專案名稱 版本 可選 3.3 http請求方法 3.4 響應狀態 客戶端請求服務求後,伺服器響應給客戶端的狀態碼。3.5 狀態碼集合彙總 序...

理解restful風格介面

網路應用程式,分為前端和後端兩個部分。當前的發展趨勢,就是前端裝置層出不窮 手機 平板 桌面電腦 其他專用裝置.因此,必須有一種統一的機制,方便不同的前端裝置與後端進行通訊。這導致api構架的流行,甚至出現 api first 的設計思想。restful api是目前比較成熟的一套網際網路應用程式的...