關於RESTful API的個人乙個總結

2021-09-23 01:57:31 字數 657 閱讀 4616

第一次聽說restful api的時候還以為這是個api管理工具,後面才知道這就是乙個api準則,類似於法律準則和會計準則,以及python的pep8一樣,就是乙個命名規範,而不是告訴你具體怎麼命名。

目前自己也還沒有深刻領悟restful的精髓,但是寫下自己的一些領悟,不斷更新迭代,也方便剛入門的同學理解。

乙個url就是乙個資源

乙個api 的url鏈結就是乙個資源,所以不應該出現動詞,只能使用名詞。get,post,put,delete已經代表了動作。

限制互動

乙個好的restful api應該只允許第三方使用者呼叫get(選擇),post(建立),put(更新),patch(更新),delete(刪除)這些動詞來進行資料互動。

名詞化說明

你的請求方式已經表名你的動作,所以url欄位裡面不應出現任何其他的動詞。

版本化說明

如果api很顯然會迭代更新,那麼你應該在api的url中直接使用版本號,如v1.1,v1.5等。

使用https

乙個好的api總是基於https發布的。

讓你的api直接通過url就能對外傳遞資訊

好的文件說明

不要使用問的那個自動化生成器。

說明每乙個url的響應結果和可能的錯誤資訊,以及什麼情況下會產生這個錯誤資訊。

ps:

個人對 RESTful API 的理解

首先,先了解下rest,rest的全稱 representational state transfer,即 表現層狀態轉化 它代表著分布式服務的架構風格。只需要寫乙個後台系統提供rest風格的uri,不同的客戶端,如瀏覽器 android ios等都請求該同乙個後台系統。那麼這些前端接收到的使用者請...

restful api響應設計個人心得

以下內容以json api規範為基礎 返回資料 將實際資料放在data中,例如 普通單數data get epics 1響應 普通複數data get epics響應 如何表達關係 get epics 1返回嵌入式規範的資料,這裡選用嵌入式的原因 響應 subtask 分頁 此處涉及兩種分頁形式 1...

關於個人管理

無論是個人管理,還是時間管理。以前自己的感受是,總感覺是老師逼著自己去做的,自己沒有體會這種方法的作用。經過前面的一些自己不管是被壓著去做,還是偶爾心血來潮去做的體會,這次再次寫個人管理。秉著索取大家的批評與建議的心態,總結幾點,與大家分享。第一點 切實可行的計畫 為什麼要說這點呢?有人說了,這不是...