服务API设计 之 API参数规范

【强制】字段名称用小驼峰风格

【强制】Service API返回值必须使用Response包装

• Service API返回值强制要求进行通用包装，例如：Response。

• Response的作用：

  1. 统一方法表示API调用是否成功
  2. API调用失败时，统一格式反馈错误Code，错误Message
  3. 统一的Response易于调用方经验复用，框架集成

• 作为API调用方，其编码诉求很简单：

  1. API调用是否成功；
  2. 调用不成功时，提示文案是什么；

• 调用方几不想：

  1. 不想关心API内部有多牛逼
  2. 不想关心API可能会抛的各种Exception，以及因此不得不做各种异常处理

• 关于当前不统一的Response

  • 【新业务】【强制】使用架构组定义的统一Response：ZCY Response
  • 目前业务方有自定义Result/Response，风格和作用大同小异。有更好的设计可以自荐给架构组集成，杜绝各自开辟重复的新定义。

【强制】杜绝完全不规范的缩写，避免望文不知义。（国际通用缩写除外）