-
Notifications
You must be signed in to change notification settings - Fork 0
/
mejai-swagger.yaml
426 lines (426 loc) · 13.2 KB
/
mejai-swagger.yaml
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
openapi: "3.0.1"
info:
title: "MejaiAPI"
description: "환영합니다! [Mejai.gg](https://example.com)는 League of Legends의 게임 데이터를\
\ 분석하여 사용자에게 통계를 제공하는 서비스입니다. 이 API 문서는 Mejai.gg의 API를 사용하는 방법을 설명합니다.\n#### 지\
원 및 문의 - API 사용 중에 문제가 발생하거나 추가적인 지원이 필요한 경우, 지원 페이지에서 도움을 받을 수 있습니다. - 새로운 기능\
\ 제안이나 버그 리포트는 리포지토리를 통해 제출해 주세요.\n#### API 작성에 참고한 문서: - [Google API design guide](https://cloud.google.com/apis/design)\n"
contact:
email: "[email protected]"
version: "0.0.1"
externalDocs:
description: "Find out more about Mejai GG"
url: "http://example.com"
servers:
- url: "https://ug9bgowsd1.execute-api.ap-northeast-2.amazonaws.com/{basePath}"
variables:
basePath:
default: "mejai-v2"
paths:
/api/v2/users/renewal/profile:
post:
tags:
- "Users"
summary: "유저 프로필 업데이트 요청"
description: "유저의 프로필 정보 업데이트 요청을 보냅니다. (SQS로 전송)"
operationId: "updateUserProfile"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/UserIdentifier"
required: true
responses:
"202":
description: "프로필 업데이트 요청 성공"
content: {}
"400":
description: "보낸 형식이 잘못됨."
content: {}
"500":
description: "서버 내부 오류(aws sqs 전송 실패)"
content: {}
/api/v2/renewal-status/profile:
get:
tags:
- "Users"
summary: "프로필 업데이트 상태 조회"
description: |
프로필 업데이트 요청의 상태를 조회합니다.
- 사용법:
/users/renewal/profile 요청을 보낸 후, 해당 요청의 상태를 조회할 수 있습니다.
/users/profile 요청에서 가져온 lastUpdated 값과 비교하여 최신화 되었으면 업데이트가 완료된 상태입니다.
최신화 될 때 까지 몇초에 한 번 요청을 보내어 상태를 확인하면 됩니다.
너무 오랜 기간동안 업데이트가 완료되지 않는다면, 다시 요청을 보내달란 메시지를 보여주세요.
operationId: "getRenewalStatusProfile"
parameters:
- name: "tag"
in: "query"
description: "소환사 태그"
schema:
type: "string"
- name: "id"
in: "query"
description: "소환사 아이디"
required: true
schema:
type: "string"
responses:
"400":
description: "기타 오류"
content: {}
"404":
description: "해당 소환사 정보 찾을 수 없음"
content: {}
"200":
description: "프로필 업데이트 상태 조회 성공"
content:
application/json:
schema:
$ref: "#/components/schemas/RenewalStatus"
/api/v2/renewal-status/streak:
get:
tags:
- "Users"
summary: "스트릭 업데이트 상태 조회"
description: |
스트릭 업데이트 요청의 상태를 조회합니다.
- 사용법:
/users/renewal/streak 요청을 보낸 후, 해당 요청의 상태를 조회할 수 있습니다.
/users/streak 요청에서 가져온 lastUpdated 값과 비교하여 최신화 되었으면 업데이트가 완료된 상태입니다.
최신화 될 때 까지 몇초에 한 번 요청을 보내어 상태를 확인하면 됩니다.
너무 오랜 기간동안 업데이트가 완료되지 않는다면, 다시 요청을 보내달란 메시지를 보여주세요.
operationId: "getRenewalStatusStreak"
parameters:
- name: "year"
in: "query"
description: "조회 시작 연도"
required: true
schema:
type: "string"
- name: "tag"
in: "query"
description: "소환사 태그"
schema:
type: "string"
- name: "month"
in: "query"
description: "조회 시작 월"
required: true
schema:
type: "string"
- name: "id"
in: "query"
description: "소환사 아이디"
required: true
schema:
type: "string"
responses:
"400":
description: "기타 오류"
content: {}
"404":
description: "해당 소환사 정보 찾을 수 없음"
content: {}
"200":
description: "스트릭 업데이트 상태 조회 성공"
content:
application/json:
schema:
$ref: "#/components/schemas/RenewalStatus"
/api/v2/users/profile:
get:
tags:
- "Users"
summary: "소환사 정보 조회 (v2)"
description: "주어진 소환사 ID와 태그를 사용하여 소환사의 프로필 정보를 조회합니다.\n"
operationId: "getUsersProfileV2"
parameters:
- name: "tag"
in: "query"
description: "소환사 태그"
schema:
type: "string"
- name: "id"
in: "query"
description: "소환사 아이디"
required: true
schema:
type: "string"
responses:
"404":
description: "해당 소환사가 라이엇에 등록되어 있지 않음"
content: {}
"200":
description: "소환사 정보 조회 성공"
content:
application/json:
schema:
$ref: "#/components/schemas/UserProfile"
"429":
description: "라이엇 API 요청 제한 초과"
content: {}
"400":
description: "기타 오류"
content: {}
"500":
description: "서버 내부 오류"
content: {}
/api/v2/users/streak:
get:
tags:
- "Users"
summary: "소환사 게임 스트릭 조회 (v2)"
description: "주어진 소환사 ID, 태그, 조회 시작 날짜, 조회 종료 날짜를 사용하여 소환사가 특정 기간 동안 진행한 게임의\
\ 총 횟수를 조회합니다.\n"
operationId: "getUserGameCountsV2"
parameters:
- name: "year"
in: "query"
description: "조회 시작 연도"
required: true
schema:
type: "string"
- name: "tag"
in: "query"
description: "소환사 태그"
schema:
type: "string"
- name: "month"
in: "query"
description: "조회 시작 월"
required: true
schema:
type: "string"
- name: "id"
in: "query"
description: "소환사 아이디"
required: true
schema:
type: "string"
responses:
"400":
description: "기타 오류"
content: {}
"404":
description: "해당 소환사 정보 찾을 수 없음"
content: {}
"200":
description: "소환사 게임 스트릭 조회 성공"
content:
application/json:
schema:
$ref: "#/components/schemas/ArrayOfUserGameCount"
/api/v2/users/search:
get:
tags:
- "Users"
summary: "검색어와 일치하는 이름을 가진 소환사 조회"
description: |
검색어와 일치하는 이름을 가진 소환사를 조회합니다.
- 사용법:
검색어를 입력하면, 검색어와 일치하는 이름을 가진 소환사를 count만큼 조회합니다.
검색어는 소환사 이름의 일부분이어도 상관없습니다.
operationId: "getUserSearchV2"
parameters:
- name: "id"
in: "query"
description: "소환사 아이디"
required: true
schema:
type: "string"
- name: "count"
in: "query"
description: "조회할 결과 갯수"
required: false
schema:
type: "integer"
default: 5
responses:
"400":
description: "기타 오류"
content: {}
"404":
description: "해당 소환사 정보 찾을 수 없음"
content: {}
"200":
description: "조회 성공"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/UserIdentifier"
/api/v2/users/renewal/streak:
post:
tags:
- "Users"
summary: "유저 스트릭 업데이트 요청"
description: "유저의 스트릭 정보 업데이트 요청을 보냅니다. (SQS로 전송)"
operationId: "updateUserStreak"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/UserStreakUpdate"
required: true
responses:
"201":
description: "스트릭 업데이트 성공"
content: {}
"400":
description: "기타 오류"
content: {}
"500":
description: "서버 내부 오류(aws sqs 전송 실패)"
content: {}
/api/v2/ranking:
get:
tags:
- "Ranking"
summary: "특정 월의 랭킹 조회"
description: "주어진 연도와 월을 기준으로 랭킹을 조회합니다.\n"
operationId: "getRanking"
parameters:
- name: "year"
in: "query"
description: "조회 시작 연도"
required: true
schema:
type: "string"
- name: "month"
in: "query"
description: "조회 시작 월"
required: true
schema:
type: "string"
responses:
"400":
description: "기타 오류"
content: {}
"404":
description: "해당 랭킹 정보 찾을 수 없음"
content: {}
"200":
description: "랭킹 조회 성공"
content:
application/json:
schema:
$ref: "#/components/schemas/MonthlyRanking"
components:
schemas:
UserProfile:
type: "object"
properties:
summonerName:
type: "string"
description: "소환사 이름"
tagLine:
type: "string"
description: "소환사 태그라인"
profileIcon:
type: "string"
description: "소환사 프로필 이미지 URL"
format: "uri"
level:
type: "integer"
description: "소환사 레벨"
flexRank:
$ref: "#/components/schemas/Rank"
soloRank:
$ref: "#/components/schemas/Rank"
lastUpdateAt:
type: "string"
description: "마지막 업데이트 시간"
format: "date-time"
Rank:
type: "object"
properties:
tier:
type: "string"
description: "티어"
tierIcon:
type: "string"
description: "티어 아이콘 이미지 URL"
format: "uri"
rank:
type: "string"
description: "랭크"
leaguePoints:
type: "integer"
description: "리그 포인트"
wins:
type: "integer"
description: "승리 횟수"
losses:
type: "integer"
description: "패배 횟수"
RenewalStatus:
type: "object"
properties:
lastUpdateAt:
type: "string"
description: "마지막 업데이트 시간"
format: "date-time"
MonthlyRanking:
type: "object"
properties:
ranking:
type: "array"
items:
type: "object"
properties:
summonerName:
type: "string"
tagLine:
type: "string"
totalGameCount:
type: "integer"
format: "int32"
UserStreakUpdate:
type: "object"
properties:
id:
type: "string"
tag:
type: "string"
year:
type: "integer"
format: "int32"
month:
type: "integer"
format: "int32"
UserIdentifier:
required:
- "id"
type: "object"
properties:
id:
type: "string"
tag:
type: "string"
ArrayOfUserGameCount:
type: "object"
properties:
userGameCounts:
type: "array"
items:
$ref: "#/components/schemas/UserGameCount"
lastUpdatedAt:
type: "string"
description: "마지막 업데이트 시간"
format: "date-time"
UserGameCount:
type: "object"
properties:
date:
type: "string"
description: "게임한 날짜"
format: "date"
gameCount:
type: "integer"
description: "해당 날짜에 진행된 총 게임 횟수"
imageUrl:
type: "string"
description: "해당 날짜에 진행된 판수에 맞는 메자이 이미지"
format: "uri"