接口规范

• 原则

• RPC-DUBBO

• 命名约定

• 参数约定

• 其他约定

• 示例

• HTTP

• 命名规范

• 协议规范

• 示例

• 状态码

• 其他

• 版本发布

• 版本升级

• 超时时间

原则

• 如无必要，勿增接口；

• 强调API的可理解性，可发现性和可用性；

• 从具体的实施和用例中抽象出来。

RPC-DUBBO

命名约定

• 【Must】接口以XXXRemoteService命名；

• 【Must】请求响应以XXXRequest、XXXResponse接口；

• 【Must】请求响应参数命名统一驼峰。

参数约定

• 【Must】接口入参和返回参数是一个大对象，不定义多参；

• 【Must】不使用void、null作为返回值。

其他约定

• 【Must】不使用重载；

• 【Must】批量接口返回值数量不得超过200；

• 【Must】不适用循环rpc