REST接口规范

Posted 2023-03-14

参考技术A 资源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对外提供的接口。