RESTful風(fēng)格的api

RESTful概念

RESTful是一種理念蹲堂,一種設(shè)計規(guī)范搁料,并不是什么協(xié)議等或详。
REST,全稱Representational State Transfer加缘,直接翻譯就是:表現(xiàn)層狀態(tài)轉(zhuǎn)化鸭叙。但是這個缺少主語,實際上應(yīng)該是“資源在網(wǎng)絡(luò)中以某種表現(xiàn)形式進行狀態(tài)轉(zhuǎn)化”拣宏。

“資源”是RESTful中最核心的概念之一沈贝。在RESTful概念中,互聯(lián)網(wǎng)中的每一樣信息都可以定義為資源勋乾,比如文本宋下、圖片、音頻辑莫、視頻等学歧。而這些資源又都可以對應(yīng)一個特定的URI(統(tǒng)一資源定位符),URI為每一個資源的地址或獨一無二的識別符各吨。

表現(xiàn)層枝笨,針對上面的“資源”,我們要進行相應(yīng)的呈現(xiàn)揭蜒,而且可以采用多種的呈現(xiàn)形式横浑,而這些呈現(xiàn)形式就叫做“表現(xiàn)層”。eg:文本的呈現(xiàn)形式屉更,JSON格式徙融、XML格式、HTML格式等瑰谜。

狀態(tài)轉(zhuǎn)化欺冀,資源通常放在服務(wù)器端,而客戶端對服務(wù)器資源的增萨脑、刪隐轩、改、查等操作砚哗,讓資源狀態(tài)發(fā)生改變龙助。這個過程便是“ 狀態(tài)轉(zhuǎn)化”。

RESTful規(guī)范

在RESTful架構(gòu)中蛛芥,每個網(wǎng)址代表一種資源(resource)提鸟,所有網(wǎng)址請求接口中不能有動詞,只能有名詞,這點和數(shù)據(jù)庫設(shè)計風(fēng)格很像仅淑。
RESTful一般使用規(guī)范(大部分情況下這樣):
(1)每一個URI代表一種資源称勋;
(2)客戶端和服務(wù)器之間,傳遞這種資源的某種表現(xiàn)層涯竟;
(3)客戶端通過四個HTTP動詞赡鲜,對服務(wù)器端資源進行操作,實現(xiàn)"表現(xiàn)層狀態(tài)轉(zhuǎn)化"庐船。

HTTP方法 安全性 冪等性 接口說明
GET 安全 冪等 獲取資源(Read)
POST 不安全 非冪等 創(chuàng)建資源(Create)
PUT 不安全 冪等 更新資源(Update)
DELETE 不安全 冪等 刪除資源(Delete)

RESTful例子

以用戶的增刪查改為例:

get : /user/list  //獲取所有用戶信息
post:/user  //創(chuàng)建用戶信息
put:/user/123  //更新用戶123的信息
get:/user/123  //獲取資源標(biāo)識(id)為123的用戶信息
delete:/user/123  //刪除資源標(biāo)識(id)為123的用戶信息

我在這里的沒有使用資源的復(fù)數(shù)形式银酬,如果使用資源的復(fù)數(shù)形式,查詢所有用戶還存在另一種表達筐钟,

get : /users  //獲取所有用戶信息

單復(fù)數(shù)的資源形勢表達在這里不做討論揩瞪,只要能讓人正確理解就行,我個人一般只使用單數(shù)形式篓冲。

其次李破,資源的表達也是需要層級的
eg:
每個用戶下?lián)碛卸啾緯?/p>

get /user/123/book/list  //查詢用戶123的書籍列表
get /user/123/book/3  //查詢用戶123的id為3的書

部門下有多個用戶

get /department/1/user/list //查詢id為1的部門的用戶列表
get /department/1/user/123 //查詢id為1的部門下的用戶123的信息

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市壹将,隨后出現(xiàn)的幾起案子嗤攻,更是在濱河造成了極大的恐慌,老刑警劉巖诽俯,帶你破解...
    沈念sama閱讀 212,718評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件妇菱,死亡現(xiàn)場離奇詭異,居然都是意外死亡暴区,警方通過查閱死者的電腦和手機闯团,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,683評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來颜启,“玉大人偷俭,你說我怎么就攤上這事$终担” “怎么了涌萤?”我有些...
    開封第一講書人閱讀 158,207評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長口猜。 經(jīng)常有香客問我负溪,道長,這世上最難降的妖魔是什么济炎? 我笑而不...
    開封第一講書人閱讀 56,755評論 1 284
  • 正文 為了忘掉前任川抡,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘崖堤。我一直安慰自己侍咱,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,862評論 6 386
  • 文/花漫 我一把揭開白布密幔。 她就那樣靜靜地躺著楔脯,像睡著了一般。 火紅的嫁衣襯著肌膚如雪胯甩。 梳的紋絲不亂的頭發(fā)上昧廷,一...
    開封第一講書人閱讀 50,050評論 1 291
  • 那天,我揣著相機與錄音偎箫,去河邊找鬼木柬。 笑死,一個胖子當(dāng)著我的面吹牛淹办,可吹牛的內(nèi)容都是我干的眉枕。 我是一名探鬼主播,決...
    沈念sama閱讀 39,136評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼娇唯,長吁一口氣:“原來是場噩夢啊……” “哼齐遵!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起塔插,我...
    開封第一講書人閱讀 37,882評論 0 268
  • 序言:老撾萬榮一對情侶失蹤梗摇,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后想许,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體伶授,經(jīng)...
    沈念sama閱讀 44,330評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,651評論 2 327
  • 正文 我和宋清朗相戀三年流纹,在試婚紗的時候發(fā)現(xiàn)自己被綠了糜烹。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,789評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡漱凝,死狀恐怖疮蹦,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情茸炒,我是刑警寧澤愕乎,帶...
    沈念sama閱讀 34,477評論 4 333
  • 正文 年R本政府宣布,位于F島的核電站壁公,受9級特大地震影響感论,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜紊册,卻給世界環(huán)境...
    茶點故事閱讀 40,135評論 3 317
  • 文/蒙蒙 一比肄、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦芳绩、人聲如沸掀亥。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,864評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽铺浇。三九已至痢畜,卻和暖如春垛膝,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背丁稀。 一陣腳步聲響...
    開封第一講書人閱讀 32,099評論 1 267
  • 我被黑心中介騙來泰國打工吼拥, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人线衫。 一個月前我還...
    沈念sama閱讀 46,598評論 2 362
  • 正文 我出身青樓凿可,卻偏偏與公主長得像,于是被迫代替她去往敵國和親授账。 傳聞我的和親對象是個殘疾皇子枯跑,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,697評論 2 351

推薦閱讀更多精彩內(nèi)容