REST接口規(guī)范

資源URL設(shè)計(jì)原則

REST風(fēng)格規(guī)定所有資源通過統(tǒng)一資源定位符(URL)定位草姻,資源的RESTful URL采用以下模板:
http(s)://ip:port/(rest)/{service-name}/{version}/{rest-convention}
一個(gè)完整URL由服務(wù)接口入口蚪战、服務(wù)接口標(biāo)識(shí)(rest)瑞筐、服務(wù)名稱{service-name}趋艘、版本號(hào){version}坎藐、服務(wù)內(nèi)資源路徑{rest-convention}組成价说,其中服務(wù)接口標(biāo)識(shí)"/rest"非規(guī)范強(qiáng)制要求

如:獲取所有角色基本信息 http://localhost:8086/rest/uam/v1/roles
【規(guī)則】若服務(wù)接口歸屬于固定域名棵磷,ip:port應(yīng)該由域名替代歹啼。
【規(guī)則】URL中字段命名采用英文半角小寫字母玄渗、數(shù)字座菠、中劃線或下劃線組合,如"search-by-group"藤树,不建議采用駝峰式命名浴滴。
【規(guī)則】URL長度應(yīng)小于2083字符,否則服務(wù)端返回414狀態(tài)碼
【規(guī)則】URL中不能包含URL特殊字符(RFC1738標(biāo)準(zhǔn))岁钓,特殊字符需使用特殊字符時(shí)需要做URL encode升略。
【規(guī)則】URL中不得包含公司安全紅線涉及的敏感信息。
【建議】website暴露給WebUI的RESTful采用模板:
http(s)://ip:port/(rest)/{website-name}/ui/{version}/{rest-convention}
說明:為保持系統(tǒng)對(duì)外接口風(fēng)格一致屡限,在{website-name}和{version}之間添加"ui"標(biāo)識(shí)當(dāng)前接口為website對(duì)外提供的接口品嚣。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市钧大,隨后出現(xiàn)的幾起案子翰撑,更是在濱河造成了極大的恐慌,老刑警劉巖啊央,帶你破解...
    沈念sama閱讀 221,198評(píng)論 6 514
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件眶诈,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡瓜饥,警方通過查閱死者的電腦和手機(jī)逝撬,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,334評(píng)論 3 398
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來乓土,“玉大人宪潮,你說我怎么就攤上這事∪に眨” “怎么了狡相?”我有些...
    開封第一講書人閱讀 167,643評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長拦键。 經(jīng)常有香客問我谣光,道長,這世上最難降的妖魔是什么芬为? 我笑而不...
    開封第一講書人閱讀 59,495評(píng)論 1 296
  • 正文 為了忘掉前任萄金,我火速辦了婚禮,結(jié)果婚禮上媚朦,老公的妹妹穿的比我還像新娘氧敢。我一直安慰自己,他們只是感情好询张,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,502評(píng)論 6 397
  • 文/花漫 我一把揭開白布孙乖。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪唯袄。 梳的紋絲不亂的頭發(fā)上弯屈,一...
    開封第一講書人閱讀 52,156評(píng)論 1 308
  • 那天,我揣著相機(jī)與錄音恋拷,去河邊找鬼资厉。 笑死,一個(gè)胖子當(dāng)著我的面吹牛蔬顾,可吹牛的內(nèi)容都是我干的宴偿。 我是一名探鬼主播,決...
    沈念sama閱讀 40,743評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼诀豁,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼窄刘!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起舷胜,我...
    開封第一講書人閱讀 39,659評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤娩践,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后逞带,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體欺矫,經(jīng)...
    沈念sama閱讀 46,200評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡纱新,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,282評(píng)論 3 340
  • 正文 我和宋清朗相戀三年展氓,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片脸爱。...
    茶點(diǎn)故事閱讀 40,424評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡遇汞,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出簿废,到底是詐尸還是另有隱情空入,我是刑警寧澤,帶...
    沈念sama閱讀 36,107評(píng)論 5 349
  • 正文 年R本政府宣布族檬,位于F島的核電站歪赢,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏单料。R本人自食惡果不足惜埋凯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,789評(píng)論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望扫尖。 院中可真熱鬧白对,春花似錦、人聲如沸换怖。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,264評(píng)論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至条摸,卻和暖如春悦污,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背钉蒲。 一陣腳步聲響...
    開封第一講書人閱讀 33,390評(píng)論 1 271
  • 我被黑心中介騙來泰國打工塞关, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人子巾。 一個(gè)月前我還...
    沈念sama閱讀 48,798評(píng)論 3 376
  • 正文 我出身青樓帆赢,卻偏偏與公主長得像,于是被迫代替她去往敵國和親线梗。 傳聞我的和親對(duì)象是個(gè)殘疾皇子椰于,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,435評(píng)論 2 359

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

  • 一說到REST,我想大家的第一反應(yīng)就是“啊仪搔,就是那種前后臺(tái)通信方式瘾婿。”但是在要求詳細(xì)講述它所提出的各個(gè)約束烤咧,以及如...
    時(shí)待吾閱讀 3,432評(píng)論 0 19
  • width: 65%;border: 1px solid #ddd;outline: 1300px solid #...
    邵勝奧閱讀 4,828評(píng)論 0 1
  • 去年有段時(shí)間得空偏陪,就把谷歌GAE的API權(quán)威指南看了一遍,收獲頗豐煮嫌,特別是在自己幾乎獨(dú)立開發(fā)了公司的云數(shù)據(jù)中心之后...
    騎單車的勛爵閱讀 20,544評(píng)論 0 41
  • 要加“m”說明是MB笛谦,否則就是KB了. -Xms:初始值 -Xmx:最大值 -Xmn:最小值 java -Xms8...
    dadong0505閱讀 4,842評(píng)論 0 53
  • 概要 64學(xué)時(shí) 3.5學(xué)分 章節(jié)安排 電子商務(wù)網(wǎng)站概況 HTML5+CSS3 JavaScript Node 電子...
    阿啊阿吖丁閱讀 9,221評(píng)論 0 3