RESTful 風格 API 設計規範

2022-09-12 01:24:19 字數 708 閱讀 5582

建議將api部署到專用網域名稱下, 如:

如果不需要考慮擴充套件可以將api當做乙個模組來開發

建議將版本放入url位址中, 如:/v1.1

get           獲取資源

post 新建資源

delete 刪除資源

put 更新資源

api應該提供引數, 比如分頁, 在pc端和移動端可能是不一樣的 比如pc端一頁 30 條資料, 而移動端是 一頁 10 條資料

/v1?offset=30

/v1?offset=10

如果後端**可能執行報錯, 應該try..catch讓**正常執行catch並返回資訊

[,,

]

文明瀏覽,不喜勿噴,謝謝!!^_^

什麼RESTful風格API

一 url 設計 1.1 動詞 賓語 restful 的核心思想就是,客戶端發出的資料操作指令都是 動詞 賓語 的結構。比如,get articles這個命令,get是動詞,articles是賓語。動詞通常就是五種 http 方法,對應 crud 操作。get 讀取 read post 新建 cre...

restful風格API簡述

3 springboot簡述 rest是representational state transfer的縮寫 維基百科上的表達是可重新表達的狀態 rest是設計風格不是標準,按照這個風格設計出的api就叫restful api 1 資源 資源這個詞在rest中是被省略的主語資源本身是乙個具體的資訊,...

設計風格 Restful

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