RESTful API接口设计指南（最新版）.docx

RESTfulAPI接口设计指南（最新版）

第一章总则

一、指南适用范围

1.本指南适用于所有企业内部Web服务接口、移动端后端接口、第三方开放平台接口的全生命周期设计工作，所有新开发的对外暴露接口必须100%符合本规范要求，存量接口迭代时需按本规范完成适配改造。

2.本指南的制定参考《GB/T35273-2020信息安全技术个人信息安全规范》《GB/T39477-2020信息安全技术政务信息共享接口规范》《GB/T19710-2005地理信息元数据》相关要求，所有设计内容不得违反现行网络安全、数据安全相关法律法规的强制条款。

二、通用设计原则

1.所有接口设计必须遵循资源导向原则，以实体资源为核心定义接口路径，禁止以操作动作作为接口命名的核心要素。接口设计需保持前后端认知一致，相同语义的接口在不同业务线中不得出现超过2种不同的实现逻辑。

2.接口性能指标必须满足单接口平均响应时间不超过200ms，峰值场景下99%的请求响应时间不超过1s，单接口最大并发承载量不低于1000QPS，超出该阈值的高流量场景必须提前做分片、缓存优化。

第二章URI路径设计规范

一、路径层级规则

1.URI全部字符统一使用小写英文字母、数字和半角横杠，禁止使用下划线、驼峰命名、中文全角字符，不同语义的单词之间使用半角横杠分隔，例如用户收货地址对应的路径为/user-rec