RESTful設計方法

2021-10-08 04:04:53 字數 1639 閱讀 8333

為什麼使用restful

representational state transfer  表現層狀態轉化( 資源定位及資源操作) 

表象層面說就是通過get,post,put,delete方式來實現前後臺通訊的一種輕量級,跨平台,跨語言架構設計風格的web服務

1 增加商品

# 增加商品

post /add-goods/

前端傳送了 post 請求

請求路徑為: /add-goods/

2 刪除商品

# 刪除商品

post /delete-goods/

前端又傳送了 post 請求

請求路徑為: /delete-goods/

3 修改商品

# 修改商品

post /update-goods/ 修改商品

前端還是傳送的 post 請求

請求路徑為: /update-goods/

4 查詢商品

# 查詢商品

get /get-goods/ 查詢商品

前端傳送的 get 請求

請求路徑為: /get-goods/

只能有名詞,不能有動詞,而且所用的名詞往往與資料庫的表名對應.

get   /products/4 :前端獲取後端的單個產品(4號商品)

get /products : 前端獲取後端的所有產品

post /products : 前端發給後端資料儲存到後端

put /products/4 :前端修改後端儲存的資料

delete /products/4 : 前端刪除後端儲存的4號資料

名詞能夠使結構簡潔.

api 中的名詞應該使用複數.

舉例來說,獲取產品的 api 可以這樣定義

獲取單個產品:

獲取所有產品:

常用的http動詞有下面四個(括號裡是對應的 sql 命令).

- get :    取出伺服器資源 (一項或多項)

- post : 往伺服器新增乙個資源.

- put : 修改伺服器儲存的資源 (客戶端需提供修改所需的完整資源)

- delete : 刪除伺服器資源

下面是一些例子:

get /zoos: 取出所有動物園

post /zoos:新建乙個動物園(上傳檔案)

get /zoos/id:獲取某個指定動物園的資訊

put /zoos/id:更新某個指定動物園的資訊(提供該動物園的全部資訊)

delete /zoos/id:刪除某個動物園

get /zoos/id/animals:取出某個指定動物園的所有動物

delete /zoos/id/animals/id:刪除某個指定動物園的指定動物

RESTful設計方法

rest rest,即representational state transfer的縮寫。維基百科稱其為 具象狀態傳輸 國內大部分人理解為 表現層狀態轉化 restful是一種開發理念。維基百科說 rest是設計風格而不是標準。rest描述的是在網路中client和server的一種互動形式 re...

RESTful 你了解RESTful設計要素嗎

在restful架構中,每個 代表一種資源,所以 中不能有動詞,只能有名詞。一般來說api中的名詞應該使用複數。例如 有乙個api提供動物園 zoo 的資訊,還包括各種動物和雇員的資訊,它的路徑應該設計成 動物園資源 動物資源 雇員資源 https 協議頭。v1 關於api的版本號 還可以加到htt...

設計風格 Restful

rest是設計風格而不是標準,只提供了一組設計原則和約束條件 資源由uri來指定 uri 統一資源識別符號 對資源的包括包括獲取 建立 修改 和刪除資源 這些操作正好對應http協議提供的get post put和delete方法 通過操作資源的表現形式來操作資源 非rest風格url http q...