-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
489 lines (483 loc) · 15.7 KB
/
openapi.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
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
# yaml-language-server: $schema=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.yaml
openapi: 3.0.3
info:
title: H3B1 pluto3 backend
description: |
H3B1 프로젝트를 위한 백엔드 API
주요기능:
- 임베디드 IP 저장
- CV 화면 송출
- CV 결과 알림
- 음성 인식과 GPT를 통한 대화
version: 1.0.0
paths:
/login:
post:
description: 로그인을 진행합니다.
requestBody:
description: 로그인을 위한 사용자 입력 정보 입니다.
required: true
content:
application/json:
example:
id: admin
password: admin123
schema:
type: object
required:
- id
- password
properties:
id:
description: 아이디
type: string
password:
description: 비밀번호
type: string
responses:
200:
description: 로그인 결과
content:
application/json:
examples:
success:
description: 로그인 성공
value:
success: true
token: eJY...
fail:
description: 로그인 실패
value:
success: false
schema:
type: object
required:
- success
properties:
success:
description: 처리 성공 여부
type: boolean
token:
description: 토큰 정보 Authorization 헤더에 넣어서 보내주세요
type: string
/cv/cv.jpg:
get:
description: AI 서버로 부터 받은 M-JPEG 스트림을 반환합니다.
responses:
200:
description: 정상적으로 스트림을 받아 반환함
content:
multipart/x-mixed-replace:
examples:
mjpegstream:
value: |
HTTP/1.1 200 OK
Content-Type: multipart/x-mixed-replace;boundary=example-boundary
Expires: Mon, 01 Jul 1980 00:00:00 GMT
Cache-Control: no-cache, no-store, must-revalidate
Pragma: no-cache
--example-boundary
Content-Type: image/jpeg
...jpeg bytes
--example-boundary
Content-Type: image/jpeg
...jpeg bytes
/cv:
get:
description: CV 검출 목록을 가져옵니다
responses:
200:
description: 검출 목록 가져오기 결과
content:
application/json:
examples:
success:
description: 검출 목록을 성공적으로 가져옴
value:
success: true
alerts:
- id: 1
message: 쓰러짐 감지!!
createdAt: 2023-05-05T04:28:16.552Z
- id: 2
message: 화재 감지!!
createdAt: 2023-05-05T04:28:50.978Z
schema:
type: object
required:
- success
- alerts
properties:
success:
description: 검출 목록 가저오기 성공 유무
type: boolean
alerts:
description: 가져온 검출 목록
type: array
items:
type: object
required:
- id
- message
- createdAt
properties:
id:
description: 알림 ID
type: number
message:
description: 알림 내용
type: string
createdAt:
description: 알림 생성 날짜
type: string
post:
description: CV에서 위험이 발견되어 보호자에게 알림을 전송합니다.
requestBody:
description: 보호자에게 표시할 알림 정보입니다.
required: true
content:
application/json:
example:
message: 화재를 감지하였습니다.
schema:
type: object
required:
- message
properties:
message:
description: 보호자에게 표시할 경고 메시지
type: string
responses:
200:
description: 알람처리 후 알림 처리 결과
content:
application/json:
examples:
success:
description: 알림 처리 성공
value:
success: true
fail:
description: 알림 처리 실패 혹은 message 필드 없음
value:
success: false
schema:
type: object
required:
- success
properties:
success:
description: 처리 성공 여부
type: boolean
/cv/subscribe:
post:
description: 보호자로 알림을 구독합니다.
requestBody:
description: 구독을 위한 FCM 정보입니다
required: true
content:
application/json:
example:
registrationToken: eJY...
schema:
type: object
required:
- registrationToken
properties:
registrationToken:
description: FCM 구독 토큰
type: string
responses:
200:
description: 알림 등록 결과
content:
application/json:
examples:
success:
description: 알림 등록 성공
value:
success: true
fail:
description: 알림 등록 실패 혹은 registrationToken 필드 없음
value:
success: false
schema:
type: object
required:
- success
properties:
success:
description: 처리 성공 여부
type: boolean
/schedules:
get:
description: 해당 날짜의 일정을 가져옵니다
parameters:
- in: query
name: date
schema:
type: string
required: true
description: '날짜 (형식: YYMMDD, 예: 230101)'
responses:
200:
description: 일정 가져오기 결과
content:
application/json:
examples:
success:
description: 일정 목록을 성공적으로 가져옴
value:
success: true
schedules:
- id: 1
content: 밥먹기
date: '230101'
createdAt: 2023-05-05T04:28:16.552Z
- id: 2
content: 병원가기
date: '230101'
createdAt: 2023-05-05T04:28:16.552Z
schema:
type: object
required:
- success
- schedules
properties:
success:
description: 일정 목록 가저오기 성공 유무
type: boolean
schedules:
description: 가져온 일정 목록
type: array
items:
type: object
required:
- id
- content
- date
- createdAt
properties:
id:
description: 일정 ID
type: number
content:
description: 일정 내용
type: string
date:
description: '날짜 (형식: YYMMDD, 예: 230101)'
type: string
createdAt:
description: 일정 생성 날짜
type: string
post:
description: 일정을 등록합니다
requestBody:
description: 일정 정보입니다.
required: true
content:
application/json:
example:
date: 230101
content: 병원가기
schema:
type: object
required:
- date
- content
properties:
date:
description: '날짜 (형식: YYMMDD, 예: 230101)'
type: string
content:
description: 일정 내용
type: string
responses:
200:
description: 일정 등록 결과
content:
application/json:
examples:
success:
description: 일정 등록 성공
value:
success: true
fail:
description: 일정 등록 실패 혹은 date, content 필드 없음
value:
success: false
schema:
type: object
required:
- success
properties:
success:
description: 처리 성공 여부
type: boolean
/ip:
get:
description: 등록된 임베디드 장치의 IP를 반환합니다.
responses:
200:
description: 등록된 IP 정보
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
description: IP 등록 여부
type: boolean
ip:
description: 임베디드 장치의 IP
type: string
examples:
success:
description: IP가 등록되어 있음
value:
success: true
ip: 172.16.3.2
fail:
description: IP가 등록되있지 않음
value:
success: false
post:
description: 임베디드 장치의 IP를 등록합니다.
requestBody:
required: true
description: 등록할 IP 정보
content:
application/json:
example:
ip: 172.16.3.2
schema:
type: object
required:
- ip
properties:
ip:
description: 임베디드 장치의 IP
type: string
responses:
200:
description: IP 등록 결과
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
description: IP 등록 결과
type: boolean
examples:
success:
description: IP가 등록됨
value:
success: true
fail:
description: ip 필드가 없음
value:
success: false
/conversations:
get:
description: 대화 목록을 가져옵니다
responses:
200:
description: 대화 목록 가져오기 결과
content:
application/json:
examples:
success:
description: 대화 목록을 성공적으로 가져옴
value:
success: true
conversations:
- id: 1
request: 안녕
response: 안녕하세요. pluto3에요
createdAt: 2023-05-05T04:28:16.552Z
- id: 2
request: 뭐해?
response: 당신이랑 대화하고 있죠!
createdAt: 2023-05-05T04:28:50.978Z
schema:
type: object
required:
- success
- conversations
properties:
success:
description: 대화목록 가저오기 성공 유무
type: boolean
conversations:
description: 가져온 대화목록
type: array
items:
type: object
required:
- id
- request
- response
- createdAt
properties:
id:
description: 대화 ID
type: number
request:
description: 대화 질문
type: string
response:
description: 생성된 대답
type: string
createdAt:
description: 대화 생성 날짜
type: string
post:
description: 음성을 인식하고 대화를 생성
requestBody:
required: true
description: 음성을 인식할 오디오 파일을 전송
content:
multipart/form-data:
schema:
type: object
required:
- audio
properties:
audio:
description: 음성을 인식할 mp3 파일
type: string
format: binary
encoding:
audio:
contentType: audio/mpeg
responses:
200:
description: 대화 처리 결과
content:
application/json:
examples:
success:
description: 대화를 처리함
value:
success: true
result: 안녕하세요! 무엇을 도와드릴까요?
fail:
description: audio 필드가 없음
value:
success: false
schema:
type: object
required:
- success
properties:
success:
description: 대화 처리 성공 유무
type: boolean
result:
description: 대화 처리 결과
type: string