-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathopenapi.yaml
More file actions
261 lines (257 loc) · 8.34 KB
/
openapi.yaml
File metadata and controls
261 lines (257 loc) · 8.34 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
openapi: 3.0.3
info:
title: Extreme To-do service API
description: |-
todo list에 할 일을 쌓아두기만? -> X <br>
하루에 중요한 할 일 <b>딱 10개만</b> 관리하는 todo list! <br>
<br>
지금 해야 할 일이 이미 10개 이상인가요? <br>
그럼 그중에서도 <b>가장 급한 일 10개부터 끝내고 생각하세요!</b>
version: 1.0.0
servers:
- url: http://localhost:8080
tags:
- name: API
description: 기본적인 API
paths:
/:
get:
tags:
- API
summary: Health check
description: |
API 서버가 잘 작동하는지 확인하는 용도의 API.
responses:
'200':
description: 멀쩡함.
/tasks:
get:
tags:
- API
summary: Get all tasks
description: |
할 일 목록을 얻는다.
responses:
'200':
description: 할 일 목록을 올바르게 얻음.
content:
application/json:
schema:
type: object
properties:
tasks:
type: array
description: 할 일 목록 배열
items:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 1강부터 3강까지 공부해야함
createdAt:
type: string
description: 할 일 등록 일시 (UTC)
example: "2024-10-01 12:34:56"
example:
tasks:
- id: "01BX5ZZKBKACTAV9WEVGEMMVRY"
title: "과제하기"
contents: "1강부터 3강까지 공부해야함"
createdAt: "2024-10-01 12:34:56"
- id: "01BX5ZZKBKACTAV9WEVGEMMVZZ"
title: "알고리즘 공부하기"
contents: "3시까지 정렬, 해시맵 공부"
createdAt: "2024-10-02 14:22:00"
post:
tags:
- API
summary: Create a task
description: |
할 일 목록을 만들기
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 제목
example: "과제하기"
contents:
type: string
description: 내용
example: "1강부터 3강까지 공부해야함"
responses:
'200':
description: 할 일을 성공적으로 생성함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 1강부터 3강까지 공부해야함
createdAt:
type: string
description: 할 일 등록 일시 (UTC)
example: "2024-10-01 12:34:56"
put:
tags:
- API
summary: Update a task
description: |
할 일 수정하기 (전체 업데이트)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 제목
example: "과제하기"
contents:
type: string
description: 내용
example: "4강부터 5강까지 공부해야함"
responses:
'200':
description: 할 일을 성공적으로 업데이트함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 5강부터 10강까지 공부해야함
updatedAt:
type: string
description: 할 일 수정 일시 (UTC)
example: "2024-10-02 12:34:56"
/tasks/{taskId}:
patch:
tags:
- API
summary: Finish a task
description: |
할 일 수정하기 (부분 업데이트)
parameters:
- name: taskId
in: path
required: true
schema:
type: string
description: Task의 식별자
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 제목
example: "과제하기"
contents:
type: string
description: 내용
example: "5강부터 10강까지 공부해야함"
taskDone:
type: boolean
description: 할 일이 완료되었는지 여부
example: true
responses:
'200':
description: 할 일을 성공적으로 수정함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
title:
type: string
description: 할 일에 대한 간단한 설명
example: 과제하기
contents:
type: string
description: 자세한 설명
example: 5강부터 10강까지 공부해야함
taskDone:
type: boolean
description: 할 일이 완료되었는지 여부
example: true
updatedAt:
type: string
description: 할 일 수정 일시 (UTC)
example: "2024-10-02 12:34:56"
delete:
tags:
- API
summary: Delete a task
description: |
할 일 삭제하기
parameters:
- name: taskId
in: path
required: true
schema:
type: string
description: Task의 식별자
responses:
'200':
description: 할 일을 성공적으로 삭제함.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Task의 식별자
example: 01BX5ZZKBKACTAV9WEVGEMMVRY
deletedAt:
type: string
description: 할 일 삭제 일시 (UTC)
example: "2024-10-02 12:34:56"
isDeleted:
type: boolean
description: 삭제 여부
example: true