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对外提供的接口。

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 8,838评论 0 19
  • width: 65%;border: 1px solid #ddd;outline: 1300px solid #...
    邵胜奥阅读 10,416评论 0 1
  • 去年有段时间得空,就把谷歌GAE的API权威指南看了一遍,收获颇丰,特别是在自己几乎独立开发了公司的云数据中心之后...
    骑单车的勋爵阅读 21,018评论 0 41
  • 要加“m”说明是MB,否则就是KB了. -Xms:初始值 -Xmx:最大值 -Xmn:最小值 java -Xms8...
    dadong0505阅读 10,406评论 0 53
  • 概要 64学时 3.5学分 章节安排 电子商务网站概况 HTML5+CSS3 JavaScript Node 电子...
    阿啊阿吖丁阅读 13,183评论 0 3

友情链接更多精彩内容