检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
微服务API接口设计规范 API设计原则 API设计规范 父主题： 微服务架构设计
API设计规范 URI设计规范 谓词/操作使用规范 参数设计规范 消息体设计规范 HTTP状态码规范 异步处理设计规范 版本设计规范 API描述文档规范 父主题：
io/specification/ 重用性提供的API需要带版本号，对外发布的API接口保持稳定，即API的参数和返回值不能随意修改或删除，API设计中尽量考虑多场景可重用性，通过领域对象分析来抽取和设计API，确保API面向未来的可重用性，要减少冗余API。 对于API修改需要评估修改影响点，决策是否修改原有API还是新增API版本。
目录 API 实现方式 Design-First（设计优先） Code-First（编码优先） API 设计规范 为用户设计 API 识别 API 的目标 Mock API Server API 实现方式 通常，设计 API 规范有
参数设计规范 参数类型及使用规范 REST API包括4种类型的参数：Header，Path，Query，Body，说明和约定如下。 Header类型参数【规则】原则上不允许将业务参数定义为Header类型 说明： 按习惯，Hea
版本号 {version}=v<1…n> 接口版本号是指接口变更的版本，不是产品版本。每次接口定义变更，都要改变接口版本号。 /v1 服务内资源路径
例如： 以接口的方式提供服务能力 接口是服务与外界联系的唯一方式服务提供者不能依赖于服务消费者，不能对外暴露内部的技术实现细节。服务之间只能通过服务接口进行交互。 接口稳定已发布的服务接口不能变化，服务升级要保持向下兼容。
弃用 随着业务的不断发展，支撑业务的 API （服务端）也会相应的发生变化。 服务端（API提供者，下同）会逐渐的淘汰部分API服务：包括字段，某个 API，甚至某个版本的所有 API。服务提供者应该尽量确保弃用 API 对客户端（API消费者，下同）产生的影响在可控范围内。整个弃用过程必须遵循如下规范。
对业务运行造成影响。 对于非空集合开启分片，应将均衡器的开启时间窗放在业务空闲时，避免分片间均衡数据与业务冲突影响性能。设置时间窗口的API接口详情请参见设置集群均衡活动时间窗。 需要基于分片键排序查询且增加数据时可以分布均匀建议使用范围分片，其他使用哈希分片。 合理设计shard
消息体设计规范 【规则1】服务接口需至少支持JSON格式作为HTTP消息体（Content body） 【规则2】消息体的key值采用JSON通用的小驼峰风格，如getProduct 【规则3】请求消息体的业务数据层次禁止超过3层，响应消息体的业务数据层次禁止超过6层
裂对业务运行造成影响。对于非空集合开启分片，应将均衡器的开启时间窗放在业务空闲时，避免分片间均衡数据与业务冲突影响性能。设置时间窗口的API接口详情请参见设置集群均衡活动时间窗。需要基于分片键排序查询且增加数据时可以分布均匀建议使用范围分片，其他使用哈希分片。合理设计shard
裂对业务运行造成影响。对于非空集合开启分片，应将均衡器的开启时间窗放在业务空闲时，避免分片间均衡数据与业务冲突影响性能。设置时间窗口的API接口详情请参见设置集群均衡活动时间窗。需要基于分片键排序查询且增加数据时可以分布均匀建议使用范围分片，其他使用哈希分片。 合理设计shard
INDEX对象设计规范（重点） 规则2.14 只创建必要的索引，创建索引必须选择合适的列和顺序 违反规范的影响： 冗余索引浪费空间，索引多影响入库效率。 组合索引中列顺序错误，影响查询效率。 最佳实践： 索引的使用需兼顾以下条件： 索引列必须是常用于过滤条件或JOIN关联条件的列。
SCHEMA对象设计规范 建议2.7 不在其他USER的私有SCHEMA下创建对象 私有SCHEMA是指创建USER时自带的同名SCHEMA，该SCHEMA为该USER私有。 违反规则的影响： 在其他用户私有SCHEMA下创建对象，对象权限不受创建者控制，OWNER也非创建者。 方案建议：
VIEW对象设计规范 建议2.16 视图的嵌套需避免超过三层 违反规范的影响： 视图嵌套过深导致执行计划不稳定、耗时不稳定。 视图依赖的对象重建风险高，锁冲突发生概率增大。 方案建议： 创建视图直接基于物理表查询，不建议嵌套视图。 父主题： GaussDB(DWS)对象设计规范
DATABASE对象设计规范 规则2.1 避免直接使用内置的DATABASE（如postgres、gaussdb等） 违反规则的影响： 内置的数据库编码、兼容模式不符合业务要求时，需要重新迁移数据。 所有业务均使用内置数据库，影响变更耗时。 方案建议： 根据实际业务需要，合理创建专用DATABASE并划分给业务使用。
🎈Key的设计规范 🎈Java对象存储方案 🎈Redis安全建议 Redis不要被外网访问，禁止bind 0.0.0.0 应当设置为bind 192.168.132.128 更改redis的默认端口不要6379，可以设置成其他的如 -port 6677
记开发和技术目标，并确保一切都符合逻辑、可扩展和经济高效。 微服务架构原则 微服务设计规范 微服务API接口设计规范 微服务网关设计 父主题： 需求评估
Location: https://example.com/photos/4577 父主题： API设计规范
TABLESPACE对象设计规范 规则2.8 禁止自定义TABLESPACE表空间 违反规则的影响： 分布式场景建表使用自定义表空间，导致表数据无法按照各DN分布式存储，出现存储倾斜。 方案建议： 创建表对象使用内置默认表空间。 父主题： GaussDB(DWS)对象设计规范
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
