ttj1314 / API-Interfaces · Commits

Go to a project

Authored by liqingzhong
Commit d0f7f519c01091eefccfdc0c7ec0a14a75aa6e99 1 parent ab034150

新潮教室接口文档提供

Inline Side-by-side
Showing 2 changed files with 153 additions and 18 deletions
@@ -14,36 +14,33 @@ Key Value结构: `KEY: <UID>, Value: Y or N` , 例如 `10623456-->Y` 表示`1062 @@ -14,36 +14,33 @@ Key Value结构: `KEY: <UID>, Value: Y or N` , 例如 `10623456-->Y` 表示`1062
14 缓存用户的签到记录。失效时间：60分钟。查询的时候，从数据库中获取，然后写入到缓存中。用户签到之后，删除缓存 14 缓存用户的签到记录。失效时间：60分钟。查询的时候，从数据库中获取，然后写入到缓存中。用户签到之后，删除缓存
15 LIST结构： `KEY: <UID> , Value: [2015-03-12 18:12:12, 2015-03-13 18:12:12 ]` 15 LIST结构： `KEY: <UID> , Value: [2015-03-12 18:12:12, 2015-03-13 18:12:12 ]`
16 16
17 -  
18 -#### 记录用户最近一次签到时间。  
19 -缓存用户最近的签到时间。 用户签到成功之后，需要设置这个值。 失效： 1个月  
20 -Key Value结构： `KEY：<UID>， Value：LAST-CHECKIN-TIME(最近签到时间（unix 秒数))`, 例如：`10623456-->143026666`  
21 -  
22 #### 所有用户的亲密度信息。 17 #### 所有用户的亲密度信息。
23 不失效。 用户签到成功，修改了亲密度之后，添加element。 18 不失效。 用户签到成功，修改了亲密度之后，添加element。
24 -SortedSet接口， `KEY： STAR_ORDER, Value: { <LAST-CHECKIN-TIME:UID>--> 亲密度信息 }`  
25 -  
26 -  
27 - 19 +SortedSet接口， `KEY： STAR_ORDER, Value: { <UID>--> 亲密度信息+LAST-UPDATE-TIME}`
28 20
29 ### 表设计 21 ### 表设计
30 22
31 -#### Table： user_cohesion 用户-亲密度表 23 +#### Table： user_star_intimacy 用户-亲密度表
32 24
33 | 列名 | 说明 | 25 | 列名 | 说明 |
34 | :--------- | :------------------- | 26 | :--------- | :------------------- |
35 -| uid| 用户ID， 主键 |  
36 -| cohesion| 亲密度（int） |  
37 -| last_update| 更新时间，格式为int (到现在的秒数) | 27 +| uid | 用户ID， 主键 |
  28 +| star_id | 明星 ID |
  29 +| num | 亲密度（int） |
  30 +| create_time | 创建时间 |
  31 +| update_time | 更新时间，格式为int (到现在的秒数) |
38 32
39 33
40 -#### Table： user_checkin_record 用户-签到记录表。 签到成功之后，添加记录 34 +#### Table： user_star_intimacy_log 用户-签到记录表。 签到成功之后，添加记录
41 35
42 | 列名 | 说明 | 36 | 列名 | 说明 |
43 | :--------- | :------------------- | 37 | :--------- | :------------------- |
44 -| id| 自增主键|  
45 -| uid| 用户ID ， 索引|  
46 -| checkin_time| 签到时间，格式为int (到现在的秒数) | 38 +| id | 自增主键 |
  39 +| uid | 用户ID ， 索引 |
  40 +| star_id | 明星 ID |
  41 +| type | 1. 签到 2. 转发 |
  42 +| add_num | 本次增加的分数 |
  43 +| create_time | 签到(转发)时间，格式为int (到现在的秒数) |
47 44
48 45
49 ### 流程 46 ### 流程
@@ -58,4 +55,4 @@ SortedSet接口， `KEY： STAR_ORDER, Value: { <LAST-CHECKIN-TIME:UID>--> 亲 @@ -58,4 +55,4 @@ SortedSet接口， `KEY： STAR_ORDER, Value: { <LAST-CHECKIN-TIME:UID>--> 亲
58 所有用户的亲密度信息Cache中取前3个 55 所有用户的亲密度信息Cache中取前3个
59 56
60 #### 获取我的亲密度排名 57 #### 获取我的亲密度排名
61 -从`记录用户最近一次签到时间`Cache 中找到用户最近一次签到时间（如果没有，则从数据库user_checkin_record中查找，并且设置到缓存中）-->从 `所有用户的亲密度信息` Cache 中找出Element的rank(ZRANK)  
  58 +用 uid，与明星 ID --> 从 `所有用户的亲密度信息` Cache 中找出Element的rank(ZRANK)
  1 +新潮教室签到
  2 +------------
  3 +
  4 +## 1. 获取当前用户亲密度，排名
  5 +
  6 +`method=app.starClass.rankInfo`
  7 +
  8 +#### 入参
  9 +
  10 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  11 +|:---------|---------:|----------:|-----:|-------:|-----:|
  12 +| uid | int | 否 | 213 | 0 |用户id|
  13 +
  14 +#### 出参
  15 +
  16 +```json
  17 +{
  18 + "alg": "SALT_MD5",
  19 + "code": 200,
  20 + "data": {
  21 + "userNum": 10,
  22 + "userRank": 2
  23 + },
  24 + "md5": "fcf7791bac08abb80ef3a2b27964386c",
  25 + "message": "获取用户亲密度成功"
  26 +}
  27 +```
  28 +
  29 +## 2.签到
  30 +
  31 +`method=app.starClass.sign`
  32 +
  33 +#### 入参
  34 +
  35 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  36 +|:---------|---------:|----------:|-----:|-------:|-----:|
  37 +| uid | int | 否 | 213 | 0 |用户id|
  38 +
  39 +#### 出参
  40 +
  41 +```json
  42 +{
  43 + "alg": "SALT_MD5",
  44 + "code": 200,
  45 + "data": {
  46 + "addNum": 10,
  47 + "logs": [
  48 + {
  49 + "addNum": 10,
  50 + "createTime": 1460112775,
  51 + "id": 211,
  52 + "starId": 1,
  53 + "type": 1,
  54 + "uid": 3703860
  55 + }
  56 + ],
  57 + "rankList": [
  58 + {
  59 + "num": 10,
  60 + "uid": 3566199,
  61 + "username": "136****8114@yohoinc.com"
  62 + },
  63 + {
  64 + "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",
  65 + "num": 10,
  66 + "uid": 3566423,
  67 + "username": "黄德才"
  68 + },
  69 + {
  70 + "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",
  71 + "num": 10,
  72 + "uid": 3703860,
  73 + "username": "曹苒"
  74 + }
  75 + ]
  76 + },
  77 + "md5": "450edbd92076dfac74701cb6421f68ae",
  78 + "message": "获取用户签到信息成功"
  79 +}
  80 +```
  81 +
  82 +## 3.转发
  83 +
  84 +`method=app.starClass.forward`
  85 +
  86 +#### 入参
  87 +
  88 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  89 +|:---------|---------:|----------:|-----:|-------:|-----:|
  90 +| uid | int | 否 | 213 | 0 |用户id|
  91 +
  92 +#### 出参
  93 +
  94 +```json
  95 +{
  96 + "alg": "SALT_MD5",
  97 + "code": 200,
  98 + "data": 10, // 本次增加的分数
  99 + "md5": "9f6ed5823862ae9009fc8084516132da",
  100 + "message": "用户转发"
  101 +}
  102 +```
  103 +
  104 +## 前 100
  105 +
  106 +`method=app.starClass.top100`
  107 +
  108 +#### 出参
  109 +
  110 +```json
  111 +{
  112 + "alg": "SALT_MD5",
  113 + "code": 200,
  114 + "data": [
  115 + {
  116 + "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",
  117 + "num": 20,
  118 + "uid": 3703860,
  119 + "username": "曹苒"
  120 + },
  121 + {
  122 + "num": 10,
  123 + "uid": 3566199,
  124 + "username": "136****8114@yohoinc.com"
  125 + },
  126 + {
  127 + "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",
  128 + "num": 10,
  129 + "uid": 3566423,
  130 + "username": "黄德才"
  131 + }
  132 + ],
  133 + "md5": "fae5f8b593b1c505eb36db1d29a80eca",
  134 + "message": "top100"
  135 +}
  136 +```
  137 +
  138 +