restful api

原文鏈接:https://blog.csdn.net/qq_41378597/article/details/85248848

  提到RESTful API 大家勢必或多或少聽說過。但是什麼是RESTful API ?如何理解RESTful API 呢?請大家耐心讀完這篇文章,相信您讀完後一定會有一個更好的理解。我個人認爲,要弄清楚什麼是RESTful API,首先要弄清楚什麼是REST。REST 全稱:REpresentational State Transfer,英文翻譯過來就是“表現層狀態轉化”。如果單看這個概念,估計大家很難理解。那下面就讓我來用一句話通俗解釋一下。 RESTful:用URL定位資源、用HTTP動詞(GET、POST、PUT、DELETE)描述操作。只要記住這句話也就不難理解了。

     Resource:資源,即數據。
     Representational:某種表現形式,比如用JSON,XML,JPEG等;
     State Transfer:狀態變化。通過HTTP動詞實現。
名詞解釋

URI(統一資源標識符):可以唯一標識一個資源
URL(統一資源定位符):可以提供找到某個資源的路徑,比如平時最常見的網址:

一般一個URL也是一個URI,比如上面的網址,即URL可以看做是URI的子集,在圖書領域中一本書都有唯一的一個isbn編號,這個編號其實也是URI。

 

        RESTful API就是REST風格的API,即rest是一種架構風格,跟編程語言無關,跟平臺無關,採用HTTP做傳輸協議。 那麼在什麼場景下使用RESTful API呢?在當今的互聯網應用的前端展示媒介很豐富。有手機、有平板電腦還有PC以及其他的展示媒介,從而你的系統的客戶端要支持瀏覽器、Android、ios等。此時你肯定不會單獨爲每個客戶端寫一個後臺系統,而是寫一個後臺系統提供rest風格的URI,這三個客戶端都請求該同一個後臺系統。那麼這些前端接收到的用戶請求統一由一個後臺來處理並返回給不同的前端肯定是最科學和最經濟的方式如(圖1-1)。RESTful API就是一套協議來規範多種形式的前端和同一個後臺的交互方式。

         

                                   圖1-1 前後端分離

       前後端分離之後,我們就不用在前端頁面中寫jstl,el表達式了,甚至連jsp都不需要使用了,直接html即可,前端跟後端的交互使用ajax+json這樣符合rest風格的架構即可,這樣做的好處就是:

項目的分工更加明確了
實現了前後端的解耦
可以將前端和後端部署到不同的服務器上來減輕服務器的壓力
前後端代碼在不同的服務器上,可以提高安全性
基於以上的這些因素,rest架構的風格越來越流行了。說完好處,我們繼續來介紹RESTful API。

 

     RESTful API由後臺也就是SERVER來提供前端來調用。前端調用API向後臺發起HTTP請求,後臺響應請求將處理結果反饋給前端。也就是說RESTful 是典型的基於HTTP的協議。那麼RESTful API有哪些設計原則和規範呢?

     1、資源。首先是弄清楚資源的概念。資源就是網絡上的一個實體,一段文本,一張圖片或者一首歌曲。資源總是要通過一種載體來反應它的內容。文本可以用TXT,也可以用HTML或者XML、圖片可以用JPG格式或者PNG格式,JSON是現在最常用的資源表現形式。

     2、統一接口。RESTful風格的數據元操CRUD(create,read,update,delete)分別對應HTTP方法:GET用來獲取資源,POST用來新建資源(也可以用於更新資源),PUT用來更新資源,DELETE用來刪除資源,這樣就統一了數據操作的接口。

     3、URI。可以用一個URI(統一資源定位符)指向資源,即每個URI都對應一個特定的資源。要獲取這個資源訪問它的URI就可以,因此URI就成了每一個資源的地址或識別符。一般的,每個資源至少有一個URI與之對應,最典型的URI就是URL。

     4、無狀態。所謂無狀態即所有的資源都可以URI定位,而且這個定位與其他資源無關,也不會因爲其他資源的變化而變化。有狀態和無狀態的區別,舉個例子說明一下,例如要查詢員工工資的步驟爲第一步:登錄系統。第二步:進入查詢工資的頁面。第三步:搜索該員工。第四步:點擊姓名查看工資。這樣的操作流程就是有狀態的,查詢工資的每一個步驟都依賴於前一個步驟,只要前置操作不成功,後續操作就無法執行。如果輸入一個URL就可以得到指定員工的工資,則這種情況就是無狀態的,因爲獲取工資不依賴於其他資源或狀態,且這種情況下,員工工資是一個資源,由一個URL與之對應可以通過HTTP中的GET方法得到資源,這就是典型的RESTful風格。

說了這麼多,到底RESTful長什麼樣子的呢?下面我們舉一些例子。

GET:http://www.xxx.com/source/id 獲取指定ID的某一類資源。

GET:http://www.xxx.com/friends/123表示獲取ID爲123的用戶的好友列表。如果不加id就表示獲取所有用戶的好友列表。

POST:http://www.xxx.com/friends/123表示爲指定ID爲123的用戶新增好友。其他的操作類似就不舉例了。

 

還是回顧我們最開始說到的那句話,即用URL定位資源、用HTTP動詞(GET,POST,PUT,DELETE)描述操作。
     在rest中會通過向服務器提交的請求類型來表示增刪改查這些操作
     GET(SELECT):從服務器取出資源。
     POST(CREATE):在服務器新建一個資源。
     PUT(UPDATE):在服務器更新資源。
     DELETE(DELETE):從服務器刪除資源。

 

          RESTful API還有其他一些規範。

①、應該將API的版本號放入URL。GET:http://www.xxx.com/v1/friend/123。或者將版本號放在HTTP頭信息中。我個人覺得要不要版本號取決於自己開發團隊的習慣和業務的需要,不是強制的。

②、URL中只能有名詞而不能有動詞,操作的表達是使用HTTP的動詞GET,POST,PUT,DELETEL。URL只標識資源的地址,既然是資源那就是名詞了。

③、如果記錄數量很多,服務器不可能都將它們返回給用戶。API應該提供參數,過濾返回結果。?limit=10:指定返回記錄的數量、?page=2&per_page=100:指定第幾頁,以及每頁的記錄數。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章