API設計 RESTful API 設計指南

2021-09-08 20:00:48 字數 1531 閱讀 3335

restful api

url定位資源,用http動詞(get,post,delete,detc)描述操作。
例如

1

. rest描述的是在網路中client和server的一種互動形式;rest本身不實用,實用的是如何設計 restful api(rest風格的網路介面);

2. server提供的restful api中,url中只使用名詞來指定資源,原則上不使用動詞。「資源」是rest架構或者說整個網路處理的核心。比如:

獲取某人的新鮮;

獲取某人的好友列表;

獲取某人的詳細資訊;

3. 用http協議裡的動詞來實現資源的新增,修改,刪除等操作。

即通過http動詞來實現資源的狀態扭**

get 用來獲取資源,

post 用來新建資源(也可以用於更新資源),

put 用來更新資源,

delete 用來刪除資源。

比如:delete http:

刪除某人的好友 (在http parameter指定好友id)

api.qc.com/v1/friends: 新增好友

api.qc.com/v1/profile: 更新個人資料

server的api如何設計才滿足restful要求?

客戶-伺服器(client-server),提供服務的伺服器和使用服務的客戶需要被隔離對待。

無狀態(stateless),來自客戶的每乙個請求必須包含伺服器處理該請求所需的所有資訊。換句話說,伺服器端不能儲存來自某個客戶的某個請求中的資訊,並在該客戶的其他請求中使用。

分層系統(layered system),伺服器和客戶之間的通訊必須被這樣標準化:允許伺服器和客戶之間的中間層(ross:**,閘道器等)可以代替伺服器對客戶的請求進行回應,而且這些對客戶來說不需要特別支援。

統一介面(uniform inte***ce),客戶和伺服器之間通訊的方法必須是統一化的。(ross:get,post,put.delete, etc)

get:從某種資源獲取資訊

(獲取 order list)

例如get /zoos:列出所有動物園

post /zoos:新建乙個動物園

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

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

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

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

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

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

RESTful API 設計指南

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

RESTful API 設計指南

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

RESTful API 設計指南

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