-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathnew-api.txt
476 lines (430 loc) · 12.2 KB
/
new-api.txt
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
返回的全为 json 数组
请求参数前带*表示可以没有
返回参数前带*表示可能没有
前带#的表示必须登录之后才能操作
获取 APP 列表(不包括被软删除的app,给用户看的)
Type: GET
URL: /api/app
Request:
[]
return:
id: int 唯一自增id
name: string APP全称
alias: string 短链接
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示 APP 首次上传的时间
updated_at: timestamp 表示 App 最后一次修改的时间
#获取用户的 APP 列表(给管理者看的,只能看到自己管理的app)
Type: GET
URL: /api/user/app
Request:
*want_deleted: bool 是否需要被软删除的app,默认为 false
return:
id: int 唯一自增id
user_id: int 代表用户的id
name: string APP全称
alias: string 短链接
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示 APP 首次上传的时间
updated_at: timestamp 表示 App 最后一次修改的时间
获取指定的 APP 信息
Type: GET
URL: /api/app/{app_id}
Request:
*want_deleted: bool 是否需要被软删除的系统版本,默认为 false
return:
id: int APP的id
name: string App的全称
alias: string App的简写
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示 APP 首次上传的时间
updated_at: timestamp 表示 App 最后一次修改的时间
ios: 数组或null
id: int 唯一自增id
itunes_url: string 详细信息的网页,下载页面
itunes_id: int iTunes官网编号
alias: string 名称缩写
description: string App描述
version: string 版本号
log: string 更新日志
size: int 文件大小
price: float 价格
coin: string 货币单位
author: string 作者
logo: string logo的URL
identification: string 辨识号
created_at: timestamp 表示首次上传的时间
updated_at: timestamp 表示最后一次修改的时间
deleted_at: timestamp 不为 null 表示被删除
android: 数组或null
id: int 唯一自增id
logo: string logo的URL
identification: string 辨识号
created_at: timestamp 表示首次上传的时间
updated_at: timestamp 表示最后一次修改的时间
deleted_at: timestamp 不为 null 表示被删除
#创建新的 APP (创建成功后需添加新版本)
Type: POST
URL: /api/app/add
Request:
name: string APP全称
alias: string App短链接 unique
return:
id: int 唯一自增id
name: string APP全称
alias: string App短链接
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示 APP 首次上传的时间
updated_at: timestamp 表示 APP 更新的时间
#删除 APP
Type: DELETE
URL: /api/app/delete
Request:
app_id: unique App 的 id
return:
[]
#恢复 APP
Type: PUT
URL: /api/app/restore
Request:
app_id: unique App 的 id
return:
id: int 唯一自增id
name: string APP全称
alias: string APP简称
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示 APP 首次上传的时间
APP下载:
Type: GET
URL: /download
Request:
version_id: unique 要下载的版本 id
return:
file: 下载的文件
#上传logo(相当于覆盖)
Type: POST
URL: /api/image
Request:
android_id: int 对应安卓系统的id
file: img 图片文件
return:
img_url: string 图片路径
获取logo
Type: GET
URL: /api/image/img_name
Request:
[]
return:
file: 图片文件
#安卓:
URL: app/{app_id}/android
新建:
Type: POST
Request:
file: img logo图片
identification: string 唯一标识码
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
identification: string 唯一标识码
created_at: timestamp 表示首次上传的时间
updated_at: timestamp 表示最后一次修改的时间
deleted_at: timestamp 不为 null 表示被删除
删除:
Type: DELETE
Request:
[]
return:
[]
恢复:
Type: PUT
Request:
[]
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
identification: string 唯一标识码
created_at: timestamp 表示首次上传的时间
updated_at: timestamp 表示最后一次修改的时间
deleted_at: timestamp 不为 null 表示被删除
#iOS:
URL: app/{app_id}/ios
新建:
Type: POST
Request:
itunes: string iTunes连接
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
identification: string 唯一标识码
deleted_at: timestamp 不为 null 表示被删除
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
删除:
Type: DELETE
Request:
[]
return:
[]
恢复:
Type: PUT
Request:
[]
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
identification: string 唯一标识码
deleted_at: timestamp 不为 null 表示被删除
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
/api/app/{app_id}
用户反馈:
URL: /feedback
获取:
Type: GET
Request:
[]
return:
id: int 唯一自增id
app_id: int 对应的app id
email: string 邮箱
name: string 名字
phone: string 电话
feedback_id: int nullable 回复的回复id
title: string 回复的标题
contents: string 回复的内容
created_at: timestamp 表示该数据首次上传的时间
添加:
Type: POST
Request:
name: string 用户的名字
phone: string 用户的电话(限定手机)
email: string 用户的邮件
app_id: int 对应的app id
*feedback_id: int nullable 回复的回复id
title: string 回复的标题
contents: string 回复的内容
return:
id: int 唯一自增id
app_id: int 对应的app id
email: string 邮箱
name: string 名字
phone: string 电话
feedback_id: int nullable 回复的回复id
title: string 回复的标题
contents: string 回复的内容
created_at: timestamp 表示该数据首次上传的时间
#删除:
Type: DELETE
Request:
feedback_id: int 要删除的评论id
return:
[]
数据:
URL: /data
获取:
Type: GET
Request:
[]
return:
id: integer data的id
app_id: integer 数据属于的app的id
key: string 数据的键名(不能重复)
value: string 数据的内容
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#添加:
Type: POST
Request:
key: string 数据的键名 unique
value: string 数据的内容
return:
id: integer data的id
key: string 数据的键名
value: string 数据的内容
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#修改:
Type: PUT
Request:
data_id: integer 要改变的data的id
key: string 数据的键名 unique
value: string 数据的新内容
return:
id: integer data的id
key: string 数据的键名
value: string 数据的内容
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#删除:
Type: DELETE
Request:
data_id: integer 想删除的数据的id
return:
[]
版本管理:
URL: /version
获取:
Type: GET
Request:
*want_deleted: bool 是否需要被软删除的版本号,默认为 false
*limit: integer 返回最新的几次版本号,默认全返回
return:
id: int 唯一自增id
file_url: string 下载的路径
version: string 对外版本号
build: 版本的id
app_id: string 关联的系统号
log: string 更新日志
description: string 版本描述
size: integer 文件大小
from: string 前一个版本号
deleted_at: timestamp 不为 null 表示该版本被删除
created_at: timestamp 表示该版本首次上传的时间
#删除:
Type: DELETE
Request:
version_id: unique 要删除的版本 id
return:
[]
#恢复:
Type: PUT
Request:
version_id: unique 要删除的版本 id
return:
id: int 唯一自增id
file_url: string 下载的路径
version: string 对外版本号
build: 版本的id
app_id: string 关联的系统号
log: string 更新日志
description: string 版本描述
size: integer 文件大小
from: string 前一个版本号
deleted_at: timestamp 不为 null 表示该版本被删除
created_at: timestamp 表示该版本首次上传的时间
#上传新版本:
Type: POST
Request:
version: string 指定的对外版本号
file: file 新版本对应的 App
log: string 更新日志
description: string 描述
return:
id: int 唯一自增id
file_url: string 下载的路径
version: string 对外版本号
build: 版本的id
app_id: string 关联的系统号
log: string 更新日志
description: string 版本描述
size: integer 文件大小
from: string 前一个版本号
deleted_at: timestamp 不为 null 表示该版本被删除
created_at: timestamp 表示该版本首次上传的时间
/**
*
*
* 下面的暂时不改,不更新
*
**/
系统:
URL: /system
获取:
Type: GET
Request:
*want_deleted: bool 是否需要被软删除的版本号,默认为 false
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
system: string 对应的系统
identification: string 唯一标识码
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#新建:
Type: POST
Request:
app_id: int 对应的 app
file: img logo图片
identification: string 唯一标识码
system: string
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
system: string 对应的系统
identification: string 唯一标识码
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#删除:
Type: DELETE
Request:
system_id: 要删除的系统id
return:
[]
#恢复:
Type: PUT
Request:
system_id: 要恢复的系统id
return:
id: int 唯一自增id
app_id: int 对应的 app
logo_url: string logo路径
system: string 对应的系统
identification: string 唯一标识码
deleted_at: timestamp 不为 null 表示该 APP 被删除
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
首屏推送:
URL: /first_screen
获取:
Type: GET
Request:
app_id: int 对应的app id
return:
id: int 唯一自增id
app_id: int 对应的app id
content: string 推送的文字内容
actived: bool true代表该推送被激活,同一时间只会有一个推送被激活
image: string nullable 推送的图片路径
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#上传(默认会激活最新上传的推送):
Type: POST
Request:
app_id: int 对应的app id
content: string 推送的文字内容
*file: img nullable 推送的图片
return:
id: int 唯一自增id
app_id: int 对应的app id
content: string 推送的文字内容
actived: bool true代表该推送被激活,同一时间只会有一个推送被激活
image: string nullable 推送的图片路径
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#激活:
Type: PUT
Request:
first_screen_id: 要激活的推送的id
return:
id: int 唯一自增id
app_id: int 对应的app id
content: string 推送的文字内容
actived: bool true代表该推送被激活,同一时间只会有一个推送被激活
image: string nullable 推送的图片路径
created_at: timestamp 表示该数据首次上传的时间
updated_at: timestamp 表示该数据最后一次修改的时间
#删除:
Type: DELETE
Request:
first_screen_id: 要激活的推送的id
return:
[]