index1.jsp
54.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base href="${serverRoot }/">
<title>接口说明</title>
<meta http-equiv="pragma" content="no-cache">
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="expires" content="0">
</head>
<body>
<h1>接口说明</h1>
<br> 接口支持返回两种数据格式:json(默认),xml
<br>
请求json为:${applicationScope.server}/method
<br> 或
${applicationScope.server}/method.json
<br>
请求xml数据为:${applicationScope.server}/method.xml
<br>
----------------------------------------------------------------------------------------------------------------------
<br> 一.用户相关接口,请求地址:${applicationScope.server}/user/方法名<br><br>
1、发送短信验证码<br><br>
<code>
/**<br>
* 发送短信验证码<br>
* @param msisdn 手机号码<br>
* @return<br>
*/<br>
@RequestMapping(value = "/sendsms", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> sendsms(@RequestParam(value = "msisdn", required = true) String msisdn));<br><br>
</code>
2、注册用户登录<br><br>
<code>
/**<br>
* 登录<br>
* @param msisdn 手机号码<br>
* @param captcha 验证码<br>
* @return<br>
*/<br>
@RequestMapping(value = "/login", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> login(<br>
@RequestParam(value = "msisdn", required = true) String msisdn,<br>
@RequestParam(value = "captcha", required = false) String captcha);<br><br>
</code>
3、第三方登录<br><br>
<code>
暂无<br><br>
</code>
4、更新用户头像<br><br>
<code>
/**<br>
* 更新用户头像<br>
* @param username 用户唯一标识<br>
* @param captcha 验证码<br>
* @param avatar 用户头像<br>
* @return<br>
*/<br>
@RequestMapping(value = "/updateAvatar", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> updateAvatar(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = false) String captcha, <br>
@RequestParam(value = "avatar", required = true) MultipartFile avatar);<br>
</code>
5、更新用户资料<br><br>
<code>
/**<br>
* 更新用户资料<br>
* @param username 用户唯一标识<br>
* @param captcha 验证码<br>
* @param msisdn 手机号码<br>
* @param name 昵称<br>
* @param signature 个性签名<br>
* @param sex 性别(male, female, unknown)<br>
* @param age 年龄<br>
* @param hometown 家乡<br>
* @param profession 专业<br>
* @return<br>
*/<br>
@RequestMapping(value = "/updateInfo", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> updateInfo(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "msisdn", required = true) String msisdn,<br>
@RequestParam(value = "name", required = false) String name,<br>
@RequestParam(value = "signature", required = false) String signature,<br>
@RequestParam(value = "sex", required = false) String sex,<br>
@RequestParam(value = "age", required = false, defaultValue = "0") int age,<br>
@RequestParam(value = "hometown", required = false) String hometown,<br>
@RequestParam(value = "profession", required = false) String profession);<br><br>
</code>
6、绑定第三方账户,QQ、微博、微信<br><br>
<code></code>
7、获取用户信息(公共接口)<br><br>
<code>
/**<br>
* 获取用户信息(公共接口)<br>
* @param username 用户唯一标识<br>
* @param captcha 请求者验证码<br>
* @param userId 被查看的用户ID<br>
* @return<br>
*/<br>
@RequestMapping(value = "/requestUserInfo", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> requestUserInfo(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "userid", required = true) int userId);<br><br>
</code>
8、关注接口<br><br>
<code>
/**<br>
* 关注接口<br>
* @param msisdn 用户唯一标识<br>
* @param captcha 验证码<br>
* @param userId 被关注者ID<br>
* @return<br>
*/<br>
@RequestMapping(value = "/dofollow", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> dofollow(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "followerid", required = true) int followerId);<br><br>
</code>
8-1、取消关注接口<br><br>
<code>
/**<br>
* 取消关注接口<br>
* @param msisdn 用户唯一标识<br>
* @param captcha 验证码<br>
* @param userId 被关注者ID<br>
* @return<br>
*/<br>
@RequestMapping(value = "/cancleFollow", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> cancleFollow(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "followerid", required = true) int followerId);<br><br>
</code>
9、获取我的关注列表<br><br>
<code>
/**<br>
* 获取我的关注列表<br>
* @param username<br>
* @param captcha<br>
* @return<br>
*/<br>
@RequestMapping(value = "/getMyFollowerList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> getMyFollowerList(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha);<br><br>
</code>
10、获取我的粉丝列表(关注我的人的列表)<br><br>
<code>
/**<br>
* 获取我的粉丝列表<br>
* @param username<br>
* @param captcha<br>
* @return<br>
*/<br>
@RequestMapping(value = "/getMyFansList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> getMyFansList(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha);<br><br>
</code>
11、收到的礼物列表<br><br>
<code>
/**<br>
* 收到的礼物列表<br>
* @param username<br>
* @param captcha<br>
* @return<br>
*/<br>
@RequestMapping(value = "/receivedGiftList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> receivedGiftList(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha);<br><br>
</code>
12、送出的礼物列表<br><br>
<code>
/**<br>
* 送出的礼物列表<br>
* @param username<br>
* @param captcha<br>
* @return<br>
*/<br>
@RequestMapping(value = "/sentGiftList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> sentGiftList(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha);<br><br>
</code>
13、充值接口 ---- 参数待定<br><br>
<code>
/**<br>
* 充值接口<br>
* @param username 用户唯一标识<br>
* @param captcha 验证码<br>
* @param money 充值金额<br>
* @return<br>
*/<br>
@RequestMapping(value = "/recharge", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> recharge (<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "money", required = true) double money);<br><br>
</code>
14、提现接口 ----- 参数待定<br><br>
<code>
/**<br>
* 提现接口<br>
* @param username 用户唯一标识<br>
* @param captcha 验证码<br>
* @param money 提现金额<br>
* @return<br>
*/<br>
@RequestMapping(value = "/withdraw", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> withdraw(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "money", required = true) double money);<br><br>
</code>
----------------------------------------------------------------------------------------------------------------------
<br> 二.App全局相关接口,请求地址:${applicationScope.server}/方法名<br><br>
1、获取App信息<br><br>
<code>
/**<br>
* 获取App信息<br>
* @param packageName 包名称<br>
* @param platform 客户端平台<br>
* @param version 版本号<br>
* @return<br>
*/<br>
@RequestMapping(value = "/requestAppInfo", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> requestAppInfo(<br>
@RequestParam(value = "packagename", required = true) String packageName,<br>
@RequestParam(value = "platform", required = true) String platform,<br>
@RequestParam(value = "version", required = true) String version);<br><br>
</code>
2、搜索接口<br><br>
<code>
/**<br>
* 搜索接口<br>
* @param keyword<br>
* @return<br>
*/<br>
@RequestMapping(value = "/search", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> search(<br>
@RequestParam(value = "keyword", required = true) String keyword);<br>
</code>
3、反馈接口<br><br>
<code>
/**<br>
* 反馈接口<br>
* @param username 用户唯一标识<br>
* @param captcha 验证码<br>
* @param message 反馈信息<br>
* @return<br>
*/<br>
@RequestMapping(value = "/feedback", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> feedback(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "message", required = true) String message);<br><br>
</code>
4、获取首页轮播图<br><br>
<code>
/**<br>
* 获取首页轮播图<br>
* @return<br>
*/<br>
@RequestMapping(value = "/getLoopBannerList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> getLoopBannerList();<br><br>
</code>
5、获取提现公式<br><br>
<code>
/**<br>
* 获取提现公式<br>
* @return<br>
*/<br>
@RequestMapping(value = "/withdrawExpression", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> withdrawExpression();<br><br>
</code>
----------------------------------------------------------------------------------------------------------------------
<br> 三.礼物相关接口,请求地址:${applicationScope.server}/gift/方法名<br><br>
5、礼物/道具列表接口<br><br>
<code>
/**<br>
* 礼物/道具列表接口<br>
* @return<br>
*/<br>
@RequestMapping(value = "/requestGiftList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> requestGiftList();<br><br>
</code>
----------------------------------------------------------------------------------------------------------------------
<br> 四.直播相关接口,请求地址:${applicationScope.server}/live/方法名<br><br>
1、获取热门直播列表<br><br>
<code>
/**<br>
* 获取热门直播列表<br>
* @return<br>
*/<br>
@RequestMapping(value = "/requestHotLiveList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> requestHotLiveList(<br>
@RequestParam(value = "start", required = true, defaultValue="1") int start,<br>
@RequestParam(value = "count", required = false, defaultValue="10") int count);<br><br>
</code>
2、获取关注的人的直播列表<br><br>
<code>
/**<br>
* 获取关注的人的直播列表<br>
* @param start<br>
* @param count<br>
* @return<br>
*/<br>
@RequestMapping(value = "/requestFollowerLiveList", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> requestFollowerLiveList(<br>
@RequestParam(value = "start", required = true, defaultValue="1") int start,<br>
@RequestParam(value = "count", required = false, defaultValue="10") int count);<br><br>
</code>
3、获取直播房间详情<br><br>
<code>
/**
* 获取直播房间详情
* @param id
* @return
*/
@RequestMapping(value = "/requestLiveRoomInfo", produces = { "application/xml", "application/json" })
@ResponseBody
public Map<String, Object> requestLiveRoomInfo(
@RequestParam(value = "liveid", required = true, defaultValue="0") int liveid);
</code>
4、开启直播接口<br><br>
<code>
/**<br>
* 开启直播接口<br>
* @param username<br>
* @param captcha<br>
* @param subject<br>
* @param tag<br>
* @param userlocation<br>
* @return<br>
*/<br>
@RequestMapping(value = "/startLive", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> startLive(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "subject", required = true) String subject,<br>
@RequestParam(value = "tag", required = true) String tag,<br>
@RequestParam(value = "userlocation", required = false) String userlocation,<br>
@RequestParam(value = "image", required = false) MultipartFile image);<br><br>
</code>
5、结束直播<br><br>
<code>
/**<br>
* 结束直播<br>
* @param username<br>
* @param captcha<br>
* @return<br>
*/<br>
@RequestMapping(value = "/stopLive", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> stopLive(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha);<br>
</code>
6、举报接口<br><br>
<code>
/**<br>
* 举报接口<br>
* @param username<br>
* @param captcha<br>
* @param liveId<br>
* @param message<br>
* @return<br>
*/<br>
@RequestMapping(value = "/report", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> report(<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "liveid", required = true, defaultValue="1") int liveId,<br>
@RequestParam(value = "message", required = false) String message);<br><br>
</code>
7、获取直播房间信息<br><br>
<code>
/**<br>
* 获取直播房间信息<br>
* @param liveid<br>
* @return<br>
*/<br>
@RequestMapping(value = "/requestLiveInfo", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> requestLiveInfo(<br>
@RequestParam(value = "liveid", required = true) int liveid);<br><br>
</code>
8、点赞接口<br><br>
<code>
/**<br>
* 点赞接口<br>
* @param username<br>
* @param captcha<br>
* @param liveid<br>
* @return<br>
*/<br>
@RequestMapping(value = "/like", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> like (<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "liveid", required = true) int liveid);<br><br>
</code>
9、赠送礼物/道具接口<br><br>
<code>
/**<br>
* 赠送礼物/道具接口<br>
* @param username 用户唯一标识<br>
* @param captcha 验证码<br>
* @param liveid 直播间ID<br>
* @param giftId 礼物ID<br>
* @param count 数量<br>
* @return<br>
*/<br>
@RequestMapping(value = "/giftGiving", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> giftGiving (<br>
@RequestParam(value = "username", required = true) String username,<br>
@RequestParam(value = "captcha", required = true) String captcha,<br>
@RequestParam(value = "liveid", required = true) int liveid,<br>
@RequestParam(value = "giftid", required = true) int giftId,<br>
@RequestParam(value = "count", required = true) int count);<br>
</code>
10、直播间贡献度详情接口<br><br>
<code>
/**<br>
* 直播间贡献度详情接口<br>
* @param liveid<br>
* @return<br>
*/<br>
@RequestMapping(value = "/getGiftStat", produces = { "application/xml", "application/json" })<br>
@ResponseBody<br>
public Map<String, Object> getGiftStat (<br>
@RequestParam(value = "liveid", required = true) int liveid);<br><br>
</code>
</body>
</html>