REST風格規定所有資源由統壹資源定位符(URL)定位,資源的RESTful URL采用以下模板:
http://IP:port/(rest)/{服務名}/{版本}/{rest約定}
壹個完整的URL由服務接口條目、服務接口標識符(rest)、服務名稱{service-name}、版本號{version}和服務內的資源路徑{rest-convention}組成,其中服務接口標識符“/rest”是非標準和強制的。
例如:獲取所有角色的基本信息http://localhost:8086/rest/uam/v 1/roles。
規則如果服務接口屬於固定域名,則ip:port應替換為域名。
常規URL中的字段命名采用英文半角小寫字母、數字、下劃線或下劃線的組合,如“search-by-group”,不建議使用駝峰命名。
規則URL長度應少於2083個字符,否則服務器將返回414狀態代碼。
規則URL不能包含URL特殊字符(RFC1738標準)。如果特殊字符需要使用特殊字符,則需要進行URL編碼。
規則URL不得包含與公司安全紅線相關的敏感信息。
建議向WebUI公開的網站RESTful采用該模板:
http://IP:port/(rest)/{網站名稱}/ui/{版本}/{ rest-約定}
註:為了保持系統外部界面的風格壹致,在{網站名稱}和{版本}之間添加“ui”,以標識當前界面是網站提供的界面。