REST API

咱們設計的REST API真的nice么?

URI設計的一些原則。

  1. URI的末尾不要添加“/”
    多一個斜杠脯燃,語義完全不同汤求,究竟是目錄旭绒,還是資源,還是不確定而多做一次301跳轉(zhuǎn)京痢?
    負面case:http://api.canvas.com/shapes/
    正面case:http://api.canvas.com/shapes

  2. 使用“-”提高URI的可讀性
    目的是使得URI便于理解奶甘,用“-”來連接單詞
    正面case:http://api.example.com/blogs/my-first-post

  3. 禁止在URL中使用“
    目的是提高可讀性,“
    ”可能被文本查看器中的下劃線特效遮蔽
    負面case:http://api.example.com/blogs/my_first_post
    別爭历造,看到效果就明白了

  4. 禁止使用大寫字母
    RFC 3986中規(guī)定URI區(qū)分大小寫甩十,但別用大寫字母來為難程序員了,既不美觀吭产,又麻煩
    負面case:http://api.example.com/My-Folder/My-Doc
    正面case:http://api.example.com/my-folder/my-doc

  5. 不要在URI中包含擴展名
    應鼓勵REST API客戶端使用HTTP提供的格式選擇機制Accept request header
    正面case:http://58.com/bj/ershou/310976
    一個case:http://58.com/bj/ershou/310976x.shtml

  6. 建議URI中的名稱使用復數(shù)
    額侣监,樓主不知道為何會有這么奇怪的建議
    正面case:http://api.college.com/students/3248234/courses
    負面case:http://api.college.com/student/3248234/course

最后,給后端研發(fā)工程師一個建議:清晰優(yōu)雅的 RESTful API是為調(diào)用者編寫的臣淤,別無腦隨意定義一些shit一樣的URI給移動/前端工程師使用橄霉,小心生命有危險。

原文:http://blog.restcase.com/7-rules-for-rest-api-uri-design/
作者:Guy Levin

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末邑蒋,一起剝皮案震驚了整個濱河市姓蜂,隨后出現(xiàn)的幾起案子按厘,更是在濱河造成了極大的恐慌,老刑警劉巖钱慢,帶你破解...
    沈念sama閱讀 221,635評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件逮京,死亡現(xiàn)場離奇詭異,居然都是意外死亡束莫,警方通過查閱死者的電腦和手機懒棉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來览绿,“玉大人策严,你說我怎么就攤上這事《銮茫” “怎么了妻导?”我有些...
    開封第一講書人閱讀 168,083評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長怀各。 經(jīng)常有香客問我倔韭,道長,這世上最難降的妖魔是什么渠啤? 我笑而不...
    開封第一講書人閱讀 59,640評論 1 296
  • 正文 為了忘掉前任狐肢,我火速辦了婚禮,結(jié)果婚禮上沥曹,老公的妹妹穿的比我還像新娘份名。我一直安慰自己,他們只是感情好妓美,可當我...
    茶點故事閱讀 68,640評論 6 397
  • 文/花漫 我一把揭開白布僵腺。 她就那樣靜靜地躺著,像睡著了一般壶栋。 火紅的嫁衣襯著肌膚如雪辰如。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,262評論 1 308
  • 那天贵试,我揣著相機與錄音琉兜,去河邊找鬼。 笑死毙玻,一個胖子當著我的面吹牛豌蟋,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播桑滩,決...
    沈念sama閱讀 40,833評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼梧疲,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起幌氮,我...
    開封第一講書人閱讀 39,736評論 0 276
  • 序言:老撾萬榮一對情侶失蹤缭受,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后该互,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體米者,經(jīng)...
    沈念sama閱讀 46,280評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,369評論 3 340
  • 正文 我和宋清朗相戀三年宇智,在試婚紗的時候發(fā)現(xiàn)自己被綠了塘雳。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,503評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡普筹,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出隘马,到底是詐尸還是另有隱情太防,我是刑警寧澤,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布酸员,位于F島的核電站蜒车,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏幔嗦。R本人自食惡果不足惜酿愧,卻給世界環(huán)境...
    茶點故事閱讀 41,870評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望邀泉。 院中可真熱鬧嬉挡,春花似錦、人聲如沸汇恤。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,340評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽因谎。三九已至基括,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間财岔,已是汗流浹背风皿。 一陣腳步聲響...
    開封第一講書人閱讀 33,460評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留匠璧,地道東北人桐款。 一個月前我還...
    沈念sama閱讀 48,909評論 3 376
  • 正文 我出身青樓,卻偏偏與公主長得像患朱,于是被迫代替她去往敵國和親鲁僚。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,512評論 2 359

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

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn)冰沙,斷路器侨艾,智...
    卡卡羅2017閱讀 134,701評論 18 139
  • {"version":"2.5","action":"ImagesSetsListAction","errorCo...
    Sunney閱讀 630評論 0 0
  • 北京時間10月1日,2017-18賽季季前賽揭幕戰(zhàn)今天正式打響拓挥,金州勇士隊主場以102比108不敵勝丹佛掘金唠梨。不過...
    coco9981閱讀 389評論 0 2
  • 2016年即將過半,總該要總結(jié)下上半年的生活和工作吧侥啤,人生不就是不斷的反思当叭、醒悟、改變后繼續(xù)前進嘛盖灸。 ...
    大可宋閱讀 327評論 0 0
  • 做一個好人蚁鳖。
    恐懼社交的金魚閱讀 114評論 0 0