forked from u-lab/u-lab-laravel-hands-on
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-document.yaml
413 lines (405 loc) · 10.9 KB
/
api-document.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
openapi: 3.0.2
info:
description: |-
2020年U-labバックエンド勉強会
PHPフレームワークLaravelの使い方を実際にデモアプリを作りながら学ぶ。
version: "1.0.0"
title: "U-lab Laravel hands on"
servers:
- url: http://localhost:8000/api/v1
tags:
- name: "hello"
description: "Hello World"
- name: "key"
description: "key関連API"
- name: "user"
description: "ユーザー関連API"
- name: "park"
description: "公園関連API"
paths:
/hello:
get:
tags:
- hello
summary: Hello World
description: |-
Hello Worldをする。
responses:
200:
description: OK
content:
application/json:
schema:
type: string
example: Hello World
/key:
post:
tags:
- key
summary: 端末ApiKey生成API
description: |-
端末を識別するためのApiKeyを生成します。
端末keyは他のユーザーを推測しにくいUUIDを使用する。
本当は認証と言うが、今回は端末ApiKeyと言うことにする
requestBody:
description: Request Body
content:
application/json:
schema:
$ref: '#/components/schemas/KeyCreateRequest'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/KeyCreateResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/user:
get:
tags:
- user
summary: Userデータ取得API
description: |-
Userデータを取得します。<br>
今回は登録時にユーザー名のみを登録したので、ユーザー名を返却する
security:
- ApiToken: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserShowResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- user
summary: Userデータ更新API
description: |-
Userデータを更新します。
ユーザー名を更新します。
security:
- ApiToken: []
requestBody:
description: Request Body
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateRequest'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/user/location:
get:
tags:
- user
summary: ユーザー位置情報取得API
security:
- ApiToken: []
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserShowResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- user
summary: ユーザー位置情報記録API
description: |-
このAPIは参加ボタンに当たる<br>
ユーザがどの公園にいるかを記録する。<br>
時刻はサーバー側で記録を取るため、requestBodyに現在時刻を含めない。
security:
- ApiToken: []
requestBody:
description: Request Body
content:
application/json:
schema:
$ref: '#/components/schemas/UserLocationCreateRequest'
responses:
200:
description: OK
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/park:
get:
tags:
- park
summary: 公園一覧取得API
description: |-
公園名と公園滞在人数を取得する<br>
公園滞在人数はクエリパラメータのstart_time(始まりの時間)とend_time(終わりの時間)とtime_diff(時間幅)の値に応じて、配列で返却する<br>
時間幅は分単位である
parameters:
- name: time_diff
in: query
description: 時間幅(分)
schema:
type: integer
minimum: 30
default: 60
- name: start_time
in: query
description: 始まりの時間
schema:
type: string
format: 'date-time'
- name: end_time
in: query
description: 終わりの時間
schema:
type: string
format: 'date-time'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ParkIndexResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/park/{id}:
get:
tags:
- park
summary: 公園の個別情報取得API
description: |-
idは公園IDである。<br>
公園名と公園滞在人数を取得する<br>
公園滞在人数はクエリパラメータのstart_time(始まりの時間)とend_time(終わりの時間)とtime_diff(時間幅)の値に応じて、配列で返却する<br>
時間幅は分単位である
parameters:
- name: id
in: path
schema:
type: integer
required: true
- name: time_diff
in: query
description: 時間幅(分)
schema:
type: integer
minimum: 30
default: 60
- name: start_time
in: query
description: 始まりの時間
schema:
type: string
format: 'date-time'
- name: end_time
in: query
description: 終わりの時間
schema:
type: string
format: 'date-time'
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ParkShowResponse'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
KeyCreateRequest:
type: object
properties:
name:
type: string
description: ユーザー名
KeyCreateResponse:
type: object
properties:
data:
type: object
properties:
token:
type: string
format: uuid
name:
type: string
description: ユーザー名
UserShowResponse:
type: object
properties:
data:
type: object
properties:
name:
type: string
description: ユーザー名
UserUpdateRequest:
type: object
properties:
name:
type: string
description: ユーザー名
UserUpdateResponse:
type: object
properties:
data:
type: object
properties:
name:
type: string
description: ユーザー名
UserLocationCreateRequest:
type: object
properties:
parkID:
type: integer
description: 公園ID
longitude:
type: number
format: float
description: 緯度
latitude:
type: number
format: float
description: 経度
ParkIndexResponse:
type: object
properties:
data:
type: object
properties:
park:
type: array
items:
$ref: '#/components/schemas/ParkModel'
ParkShowResponse:
type: object
properties:
data:
$ref: '#/components/schemas/ParkModel'
ParkModel:
type: object
properties:
id:
description: 公園ID
type: integer
name:
description: 公園名
type: string
count:
description: 合計滞在人数
type: integer
people:
description: 滞在時間ごとの滞在人数
type: array
items:
type: object
properties:
count:
description: 人数
type: integer
start_time:
description: 始まりの時間
type: string
format: 'date-time'
end_time:
description: 終わりの時間
type: string
format: 'date-time'
ErrorResponse:
type: object
properties:
code:
type: integer
description: ステータスコード
message:
type: string
description: エラーメッセージ
required:
- code
- message
securitySchemes:
ApiToken:
type: apiKey
in: header
name: X-API-TOKEN