對restful API的理解

2021-10-01 07:39:07 字數 805 閱讀 3180

​ restful是一種軟體設計風格,一種思想,它不是一種標準規定,不使用restful風格api,我們也能正常開發工作,它只是一種大家比較提倡的設計規範。

​ 我們平時設計介面時,常根據自己所做的功能為介面起名稱,比如要寫乙個查詢使用者列表的介面,我們可能會起/queryuser的介面名,有的人會起selectuser、userlist的介面名,我們把我們要做的動作通過單詞來表達,可能同乙個功能,不同的人能寫出不同的介面,同時不同人理解不一樣可能會增加溝通難度。如我們用restful風格設計api,那麼查詢使用者列表介面就是/users的get介面,users表示使用者資源,get表示獲取資源。

請求方式

api說明

get/users

查詢使用者列表

get/users/123

檢視某個使用者

post

/users

新建使用者

put/users/123

更新使用者(全部字段)

patch

/users/123

更新使用者(部分字段)

delete

/users/123

刪除使用者

​ 通過介面對伺服器進行請求,其實是對資源的一種操作,所以介面名應該要表達出要操作的資源,最好用名詞的複數形式表示。除了介面的命名,對介面的返回結果,我們也應該規範起來,返回結果最好統一為json字串的形式,方便前端解析,同時返回結果除了包含業務資料外,也應該包含請求的狀態碼,方便後端人員通過狀態碼大致可知請求處理過程,建議封裝乙個統一返回結果的response物件。

下面是常見的http狀態碼:

詳細的狀態碼:

對RESTful API的理解

restful是目前最流行的api設計規範,用於web資料介面的設計。一句話描述restful就是 客戶端傳送請求時,用uri定位資源,用http方法描述動作。也就是 動詞 賓語 的結構。get 獲取資料 post 傳送資料 put 更新資料 delete 刪除資料 uri應該是名詞,不能是動詞。比...

個人對 RESTful API 的理解

首先,先了解下rest,rest的全稱 representational state transfer,即 表現層狀態轉化 它代表著分布式服務的架構風格。只需要寫乙個後台系統提供rest風格的uri,不同的客戶端,如瀏覽器 android ios等都請求該同乙個後台系統。那麼這些前端接收到的使用者請...

說說自己對RESTful API的理解

知乎上有句話總結的很好了,url定位資源用http動詞 get post delete 描述操作。其實只要理解以下幾個原則就可以了 1.提供資源定位 一般在計算機系統中,client和server通訊交換資訊,發出action來完成任務。假設在乙個to do list的web應用中,客戶需要新增或者...