細說RESTful API之設計原則

2022-03-22 16:45:57 字數 426 閱讀 2115

1. rest api uri設計的7個準則

(1)uri末尾不需要出現斜槓/

(2)在uri中使用斜槓/表達層級關係

(3)在uri中可以使用連線符-提公升可讀性

(4)在uri中不允許出現下劃線字元_

(5)在uri中優先使用小寫字元

(6)在uri中不允許出現副檔名,而應該使用content-type生命訊息型別

(7)在uri中使用複數形式

詳見:2. 5個rest api設計指導原則

(1)資源定義

(2)http方法

(3)http訊息頭

(4)查詢引數

(5)響應狀態碼

詳見:

細說RESTful API之冪等性

冪等性原本是數學中的含義,表示式的是n次變換與1次變換的結果相同。而restful api中的冪等性是指呼叫某個方法1次或n次對資源產生的影響結果都是相同的,需要特別注意的是 這裡冪等性指的是對資源產生的影響結果,而不是呼叫http方法的返回結果。舉個例子,restful api中的get方法是查詢...

微服務之Restful API 設計簡述

或https v1 zoos dynos get select 從伺服器取出資源 一項或多項 post create 在伺服器新建乙個資源。put update 在伺服器更新資源 客戶端提供改變後的完整資源 patch update 在伺服器更新資源 客戶端提供改變的屬性 delete delete...

RESTful API 設計指南

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