/hyena

用户余额/积分微服务

Primary LanguageJavaApache License 2.0Apache-2.0

Hyena

Travis (.org) branch Coverage Status Maven License

用户余额/积分微服务

积分相关接口

更多接口介绍可查看swagger文档. swagger-ui的访问URL /swagger-ui.html

增加积分

  • 给指定用户增加积分,调用成功后返回该用户的积分明细.
  • URL: /hyena/point/increase
  • Http Method: Post
  • Content-Type: application/json;charset=utf-8
  • 请求参数
参数名 类型 含义 必传 备注
seq string 请求序列号.
1, 用于匹配请求消息和响应消息;
2, 做接口幂等性校验.
序列号为空时表示不做匹配及幂等性校验.		 每次新的请求使用不同的随机字串. 如果是重送请求使用相同的序列号
type string 积分类型 可自定义类型, 用于存储'积分', '余额', 'XX币'等. 为空时, 自动创建类型为'default'的积分
uid string 用户标识 是
point number 积分数量 是 要增加的积分数量
expireTime string 过期时间. 不传表示永不过期. 格式为 "yyyy-MM-dd HH:mm:ss".
如: 2018-10-25 18:34:32 表示2018年10月25日18点34分32秒过期
tag string 自定义标签
note string 备注
  • 请求消息示例
{
    "uid" : "user_123",
    "point" : 987654
}
  • 返回结果
参数名 类型 含义 备注
status number 接口调用返回结果 0 表示成功, 其他都表示接口调用失败
seq string 请求序列号 返回请求消息里的序列号.
仅当请求消息有seq时, 响应消息才会返回seq.
data.uid string 用户标识
data.point number 用户总有效积分
data.available number 当前可用积分
data.used number 已使用的积分
data.frozen number 当前冻结的积分
data.expire number 已过期的积分
  • 返回结果示例
{
    "status" : 0,
    "data" : {
        "uid" : "user_123",
        "point" : 987654,
        "available" : 987654,
        "used" : 0,
        "frozen" : 0,
        "expire" : 0
    }
}

冻结积分

  • 冻结指定用户的积分,被冻结积分的数量不能超过当前用户的可用积分. 调用成功后返回用户积分明细.
  • URL: /hyena/point/freeze
  • Http Method: Post
  • Content-Type: application/json;charset=utf-8
  • 请求参数
参数名 类型 含义 必传 备注
seq string 请求序列号.
type string 积分类型 与增加积分时的类型一致
uid string 用户标识 是
point number 积分数量 是 要冻结的积分数量
note string 备注
  • 返回结果. 数据结构与增加积分的数据结构一致.

解冻积分

  • 解冻指定用户的积分,解冻的积分数量不能超过当前用户已冻结的积分数量. 调用成功后返回用户积分明细.
  • URL: /hyena/point/unfreeze
  • Http Method: Post
  • Content-Type: application/json;charset=utf-8
  • 请求参数
参数名 类型 含义 必传 备注
seq string 请求序列号.
type string 积分类型 与冻结积分时的类型一致
uid string 用户标识 是
point number 积分数量 是 要解冻的积分数量
note string 备注
  • 返回结果. 数据结构与增加积分的数据结构一致.

消费积分

  • 用户积分消费后调用该接口. 被消费的积分数量不能超过当前可用积分. 调用成功后返回用户积分明细.
  • URL: /hyena/point/decrease
  • Http Method: Post
  • Content-Type: application/json;charset=utf-8
  • 请求参数
参数名 类型 含义 必传 备注
seq string 请求序列号.
type string 积分类型 与增加积分时的类型一致
uid string 用户标识 是
point number 积分数量 是 要消费的积分数量
note string 备注
  • 返回结果. 数据结构与增加积分的数据结构一致.

消费已冻结积分

  • 用户消费已冻结的积分后调用该接口. 被消费的积分数量不能超过当前已冻结的积分. 调用成功后返回用户积分明细.
  • URL: /hyena/point/decreaseFrozen
  • Http Method: Post
  • Content-Type: application/json;charset=utf-8
  • 请求参数
参数名 类型 含义 必传 备注
seq string 请求序列号.
type string 积分类型 与冻结积分时的类型一致
uid string 用户标识 是
point number 积分数量 是 要消费的积分数量
note string 备注
  • 返回结果. 数据结构与增加积分的数据结构一致.

撤销积分

  • 撤销之前给用户增加的积分. 调用成功后返回用户积分明细.
  • URL: /hyena/point/cancel
  • Http Method: Post
  • Content-Type: application/json;charset=utf-8

获取用户积分列表

  • 按条件查询用户列表.
  • URL: /hyena/point/listPoint
  • Http Method: GET
  • Content-Type: application/json;charset=utf-8

获取积分明细列表

  • 按条件查询用户积分记录.
  • URL: /hyena/point/listPointRecord
  • Http Method: GET
  • Content-Type: application/json;charset=utf-8

示例代码

Maven

<dependency>
    <groupId>io.github.alphajiang</groupId>
    <artifactId>hyena-spring-boot-starter</artifactId>
    <version>0.0.4</version>
</dependency>

Gradle

plugins {
	id 'org.springframework.boot' version '2.1.4.RELEASE'
	id 'java'
}
apply plugin: 'io.spring.dependency-management'
dependencies {
    implementation("io.github.alphajiang:hyena-spring-boot-starter:0.0.4")
	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.0.1'
	implementation("org.springframework.boot:spring-boot-starter")
	implementation("org.springframework.boot:spring-boot-starter-web")
	implementation("org.springframework.boot:spring-boot-starter-jdbc")

	runtimeOnly 'mysql:mysql-connector-java'
}

Java代码

@SpringBootApplication
@ComponentScan({ "io.github.alphajiang.hyena" })
@MapperScan(basePackages = { "io.github.alphajiang.hyena.ds.mapper" })
@EnableTransactionManagement
@EnableScheduling
public class HyenaMain {
    public static void main(String[] args) {
        new SpringApplicationBuilder(HyenaMain.class).web(WebApplicationType.SERVLET).run(args);
    }
}