JAVA接口开发规范

JAVA接口开发规范

1. 实现规范
   1. 接口应功能单一，并能正确相应
   2. 建议使用restful方式来实现
   3. 不要返回null值
   4. 服务已https对外提供，符合安全规范
   5. 接口编码尽量统一使用UTF-8
   6. 接口参数的校验
2. 代码规范
   1. 规范的类名、方法名、变量名等
      1. 类名使用 UpperCamelCase 风格，遵从驼峰形式
      2. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，遵从驼峰形式,首字母小写
      3. 常量命名全部大写，单词间用下划线隔开
   2. 有效完整的代码注释
   3. 尽量使用post形式接受参数
   4. 统一使用json格式返回响应数据
   5. 使用统一的接口相应数据结构：调用状态码status、状态信息msg、自定义数据data
   6. 有效的日志记录
3. 文档完善
   1. 确保文档的唯一性
   2. 文档内容要丰富标准
      1. 接口名称、版本
      2. 用途、调用场景、授权
      3. 开发语言、编码、协议、签名等
      4. 接口示例、参数说明、返回值说明