REST接口规范

资源URL设计原则

REST风格规定所有资源通过统一资源定位符（URL）定位，资源的RESTful URL采用以下模板：

http(s)://ip:port/(rest)/{service-name}/{version}/{rest-convention}

一个完整URL由服务接口入口、服务接口标识（rest）、服务名称{service-name}、版本号{version}、服务内资源路径{rest-convention}组成，其中服务接口标识"/rest"非规范强制要求

如：获取所有角色基本信息 http://localhost:8086/rest/uam/v1/roles

【规则】若服务接口归属于固定域名，ip:port应该由域名替代。

【规则】URL中字段命名采用英文半角小写字母、数字、中划线或下划线组合，如"search-by-group"，不建议采用驼峰式命名。

【规则】URL长度应小于2083字符，否则服务端返回414状态码

【规则】URL中不能包含URL特殊字符（RFC1738标准），特殊字符需使用特殊字符时需要做URL encode。

【规则】URL中不得包含公司安全红线涉及的敏感信息。

【建议】website暴露给WebUI的RESTful采用模板：

http(s)://ip:port/(rest)/{website-name}/ui/{version}/{rest-convention}

说明：为保持系统对外接口风格一致，在{website-name}和{version}之间添加"ui"标识当前接口为website对外提供的接口。

这种方法为从urlparse模块中通过urlparse方法提取url通过hostname属性获取当前url的域名。 此方法是通过urllib模块中splittype方法先从url中获取到proto协议及rest结果，然后通过splithost从rest中获取到host及rest结果，此时host为域名。（rest被分割了两次）如下图： 此方法为从sokcet模块中获取到gethostbyname方法将域名传递进去就能解析出域名的ip。 此方法为通过nslookup获取域名的ip。 以上从域名中提取ip会不准确，需要设置DNS服务器，这样解析域名就准确了。

不可以。btsow是老牌搜索网站，也是最常用的网站之一，btsow.rest是它的域名之一，该网站经常会更换后缀域名。如果想要手机浏览，需要下载btsow专门的APP，通过APP浏览。

---