RESTful 介面設計規範 筆記

JocelynFung發表於2024-10-12

協議: API與使用者的通訊協議,http,https協議
域名: eg: http://example.com
版本: 如果介面有版本的迭代的話,可以在域名後面拼接版本標識,eg:http://example.com/v1
路徑 又稱終點 endpoint, 表示api的具體網址
在restful架構中,每個網址代表一種資源,所以網址中不能有動詞,只使用名詞且往往與資料庫中的表格名對應。一般資料庫中的表都是同種記錄的集合,所以api中的名詞也應該使用複數。

http動詞,即介面的請求方法,eg: get,post,put(完整更新),patch(部分更新),DELETE, head(獲取資源的後設資料),options(獲取資訊,關於資源的那些屬性是客戶端可以改變的)。

過濾資訊

狀態碼
客戶端的每一次請求,伺服器都必須給出回應,回應包括http狀態碼和資料兩部分。


返回結果


錯誤處理


身份認證

跨域處理
可以在服務端設定cors允許客戶端跨域資源請求,或客戶端設定代理

相關文章