資源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ì)外提供的接口品嚣。