发表于： 2018-01-09 17:14:37
1 473
今天完成的事
编写接口文档
一、约定
1.查询多个的列表形式如id=2&id=3&id=4这种数据的形式。
2.如无特殊标注，所有的Post和Put操作都以Application/json 的方式提交，这样适合于复杂的模型。 一些简单的操作应注明 “application/x-www-form-urlencoded”
3.所有的返回字段都包含code和Message，code=0为正常，异常以 code为负表示，前端负责展示错误信息。
4.Rest风格
5./u/代表着是必须登录才可以访问的接口 如果不登录会报-6002错误
6.上传图片操作都以multipartFile的方式提交.
7.字段 第几页 page 不写时默认为1
8.字段 展示数量 size 不写时默认为10
前台字段约定:
前台所有接口中的status入参，如果没有特殊标注，全部为必填且值为1.
验证注册：
字段 用户账号状态 userStatus 0-冻结 1-正常 用户注册后默认为1
查询/更新用户详情:
字段 类型 type 0-用户注册/登陆过程中调用接口 1-用户点击"我的"调用接口 2-用户点击"账户设置"调用接口
字段 实名状态 verification 0-未实名 1-已实名 用户注册后默认为0
字段 用户状态 userStatus0-冻结 1-正常
查询交易流水
字段 交易状态 tradeStatus 0-失败 1-成功
字段 交易类型 tradeType 0-还款 1-付款
查询用户消息
字段 消息类型 messageType 0-系统消息 1-公告消息
字段 系统消息类型 autoMessageType 0-投资成功 1-投资失败 2-即将到期 3-正在回款 4-回款成功 5-回款失败 6 续投成功 7 续投失败-1 不是系统消息
字段 发送人群recipient 0-单个用户 1-所有人 2-认证投资人 系统消息为0,公告消息为1或2
字段 类型 sendType 0-定时发送 1-即时发送
字段 同步推送 synchronization 0-否 1-是
字段 状态 messageStatus 0-草稿 1-上线
查询产品
字段 起息方式 chargingInterestWay 0-T+0 1-T+1 2-T+2
字段 角标 flag 0-最新 1-热门 2-普通
字段 精品推荐 recommended 0-所有产品(包括精品推荐) 1-精品推荐产品
字段 限购状态 limited 0-否 1-是
字段 还款方式 paymetBackWay 0-按月付息,到期还本 1-到期一次性还本付息
字段 产品状态 productStatus 0-草稿 1-上线
用户产品
字段 投资类型 investType 0-正常投资 1-续投产品
字段 投资状态 investStatus 0-已退出 1-退出中 2-投资中 3-已续投
查询内容
字段 内容类型 contentType 0-推荐banner图 1-帮助中心 2-关于我们
字段 内容状态 contentStatus 0-草稿 1-上线
查询合同
字段 合同类型 contractType 0-出借咨询与服务协议-新手计划 1-出借咨询与服务协议-按月付息产品 2-出借咨询与服务协议-到期一次性还本付息产品 3-出借确认和债权转让 - 授权委托书
4-催收及诉讼 - 授权委托书 5-出借本金确认书 6-债权转让协议
字段 合同状态 contractStatus 0-用户查看产品合同模版 1-用户查看自己投资的产品的合同
查询回款计划
字段 回款状态 repaymentStatus 0-已还款 1-未还款
后台字段约定
查询用户/更新用户
字段 用户状态 status 0-冻结 1-正常
字段 消息状态 messageChecked 0-无未读消息 1-有未读消息 用户注册后默认为0
字段 实名状态 verifiedStatus 0-未认证 1-已认证 2-已拒绝 3-已取消 用户提交实名认证时默认为0，前端发送请求时只带1和2两种参数值
字段 功能约定 function 0-更新用户手机号 1-更改用户状态（是否冻结） 2-解绑银行卡 3-审核实名
查询用户交易记录/投资记录
字段 交易状态 tradeStatus 0-失败 1-成功
字段 交易类型 tradeType 0-付款 1-回款
查询/新增/编辑产品
字段 还款方式paymentBackWay 0-按月付息,到期还本 1-到期一次性还本付息
字段 起息方式 chargingInterestWay 0-T+0 1-T+1 2-T+2
字段 角标 flag 0-最新 1-热门 可以为null
字段 精品推荐 recommended 0-否 1-是
字段 限购状态 limited 0-否 1-是
字段 产品状态 productStatus 0-停售 1-在售
查询/新增/编辑债权
字段 债权状态 creditStatus 0-未使用 1-使用中 2-已到期 新增时默认为0
字段 是否已匹配 matched 0-未匹配 1-已匹配
查询/新增/编辑内容
字段 内容类型 type 0-推荐banner图 1-帮助中心 2-关于我们
字段 内容状态 status 0-草稿 1-上线 新增时默认为0
查询/更新/新增消息
字段 消息状态 status 0-草稿 1-上线 2-全部
字段 发送人群recipient 0-所有人 1-认证投资人 2单个用户 公告消息选择0或1,系统消息永远为2
字段 系统消息类型 messageType 0-投资成功 1-投资失败 2-即将到期 3-正在回款 4-回款成功 5-回款失败
字段 消息类型 type 0-系统消息 1-公告消息
字段 发送方式 sendType 0-定时发送 1-即时发送
字段 同步推送 synchronization 0-否 1-是
查询合同
字段 合同类型 contractType 0-新手计划出借咨询与服务协议 1-按月付息产品出借咨询与服务协议 2-到期一次性还本付息产品出借咨询与服务协议 3-授权委托书-出借确认和债权转让协议编号 4-授权委托书-催收及诉讼协议编号 5-出借本金确认
第三方API接口：
字段 短信类型 type 0-用户注册 1-找回密码 2-债务快到期 3-总债务匹配到达警戒线提醒
字段 存储图片类型 type 0-用户身份证正面 1-用户身份证反面 2-用户电子签名 3-"关于我们"内容 4-"帮助中心内容" 5-"推荐页"banner图封面 6-"推荐页"banner图内容 7-公告消息内容
8-银行图标 9-平台公章
======================================================================================================================================
收获
SpringBoot 依赖管理
- 继承Spring Boot的提供的父工程，需要在pom.xml中配置，如下：
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.0.BUILD-SNAPSHOT</version>
</parent>
这个父工程提供了多项的默认设置：
● 默认编译等级为Java1.6
● 默认编码为UTF-8
● 依赖管理模块（dependencyManagement），可以不配置version。
● maven插件及resource filter的配置
● 转为application.properties及application.yaml提供的resource filtering配置
○ 需要注意的一点是Spring Boot将Maven占位符设置为@…@，而不是常见的${…}，如果需要替换可以通过设置resource.delimiter来完成
- 通过scope=import的方式引入
在很多时候我们需要继承自有的父工程或由于其他设置无法使用Spring Boot提供的父工程。此时可以通过scope=import的方式进行引入，如下：
遇到的问题
短信发送模块报错了。一顿抢修修好了。浪费三块钱短信费，很难受。m
明天完成的事
接着准备
返回列表
评论