Restful 設計規範學習個人總結

2021-07-14 07:51:42 字數 765 閱讀 2783

參考:

get:獲取資源

post:增加資源

put:更新資源

delete:刪除資源

2.1、簡單

2.2、可讀性好

2.3、使用名詞,而不是動詞

2.4、使用正確的英文單詞

2.5、最好全部使用小寫

2.6、一般使用複數,因為資料是很多的

2.7、多級的uri,盡量支援各個層級的uri都是有效的,例如:/a/b/c/   則盡量讓  /a /a/b /a/b/c /a/b/c/ 都是可用

200 ok  - 成功返回狀態,對應,get,put,patch,delete.

201 created - 成功建立。

304 not modified - http快取有效。

400 bad request - 請求格式錯誤。

401 unauthorized - 未授權。

403 forbidden - 鑑權成功,但是該使用者沒有許可權。

404 not found - 請求的資源不存在

405 method not allowed - 該http方法不被允許。

410 gone - 這個url對應的資源現在不可用。

415 unsupported media type - 請求型別錯誤。

422 unprocessable entity - 校驗錯誤時用。

429 too many request - 請求過多。

RESTFUL介面設計規範

rest 是representational state transfer的縮寫,意思是表述性狀態轉移,我個人理解就是資源資料的變化。api與使用者的通訊協議,總是使用https協議。協議網域名稱 應該盡量將api部署在專用網域名稱之下。如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域...

RESTful 風格 API 設計規範

建議將api部署到專用網域名稱下,如 如果不需要考慮擴充套件可以將api當做乙個模組來開發 建議將版本放入url位址中,如 v1.1 get 獲取資源 post 新建資源 delete 刪除資源 put 更新資源api應該提供引數,比如分頁,在pc端和移動端可能是不一樣的 比如pc端一頁 30 條資...

微服務RESTful 介面設計規範

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