REST API基礎介紹

2021-10-13 07:31:28 字數 1240 閱讀 9749

1、介面中盡量使用名詞

2、使用post請求資源

3、delete請求刪除資源

eg.get/notes/id:獲取某個指定id的筆記資訊

1、rest

resource representational state transfer: 資源在網路傳輸中 以某種 表現形式 進行 狀態轉移

ps: 網際網路通訊協議http協議,是乙個無狀態協議,所有的資源狀態都儲存在伺服器端

綜上:每乙個uri代表一種資源

客戶端和伺服器之間,傳遞這種資源的某種形式表現比如json,xml,image,txt等等

客戶端通過特定的http動詞,對伺服器端資源進行操作,實現"表現層狀態轉化"。

1、動作

2、路徑(介面命名)

3、過濾資訊(filtering)

eg.

get    /classes?state=active&name=guidegege
get    /classes?page=1&size=10
4、狀態碼(status codes)

狀態碼範圍:

2xx:成功

3xx:重定向

4xx:客戶端錯誤

5xx:伺服器錯誤

200 成功

301 永久重定向

400 錯誤請求

500 伺服器錯誤

201 建立

304 資源未修改

401 未授權

502 閘道器錯誤

403 禁止訪問

504 閘道器超時

404 未找到

405 請求方法不對

1、restful 的極致是 hateoas

eg.當使用者向 api.example.com 的根目錄發出請求,會得到這樣乙個文件。

}
link: 使用者讀取這個屬性就知道下一步該呼叫什麼api了

rel: 這個api與當前**的關係(collection關係,並給出該collection的**)

href: 表示api的路徑

title: api的標題

type: 表示返回型別

3、hypermedia api的設計被稱為hateoas

rest api入門介紹

隨著 rest 成為大多數 web 和 mobile 應用的預設選擇,勢必要對它的基本原理有所了解。在它提出十多年後的今天,rest 已經成為最重要的 web 應用技術之一。隨著所有技術朝著 api 方向發展,它的重要性有可能持續快速地增長。每門主要程式語言現在已經包含構建 restful web ...

筆記 REST API 設計

evernote export body,td 04 07 2015 saturday 15 50 04 07 2015 saturday 17 48 liker.xu head 安全 冪等 options 安全 冪等 put 寫操作 更新或新增資源 冪等,多次插入或者更新同乙份資料,不安全 pos...

軟體定義網路基礎 REST API的設計規範

rest api是基於http協議進行設計的,由http動詞 uri組成 文件是資源的單一表現形式 集合是資源的乙個容器 目錄 可以向裡面新增 資源 文件 客戶端管理的乙個資源庫,可以向倉庫中新增資源 或者刪除資源,或者從倉庫中獲取資源 可以執行乙個方法,支援引數輸入,結果返 回。文件 docume...