-
Notifications
You must be signed in to change notification settings - Fork 0
/
article-service-api-docs.yaml
314 lines (314 loc) · 7.56 KB
/
article-service-api-docs.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
openapi: 3.0.1
info:
title: article-service
description: API 명세
contact:
name: kimdoyeob
url: https://github.com/KalGookSoo/springboot-msa
email: look3915@naver.com
license:
name: Apache 2.0
url: http://springdoc.org
version: 1.0.0
servers:
- url: http://127.0.0.1:8084
description: Generated server url
tags:
- name: ArticleRestController
description: 게시글 API
paths:
/articles/{id}:
get:
tags:
- ArticleRestController
summary: 게시글 조회
description: 게시글을 조회합니다
operationId: findById
parameters:
- name: id
in: path
description: 게시글 식별자
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntityModelArticle'
put:
tags:
- ArticleRestController
summary: 게시글 수정
description: 게시글을 수정합니다
operationId: update
parameters:
- name: id
in: path
description: 게시글 식별자
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateArticleCommand'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntityModelArticle'
delete:
tags:
- ArticleRestController
summary: 게시글 삭제
description: 게시글을 삭제합니다
operationId: delete
parameters:
- name: id
in: path
description: 게시글 식별자
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
/articles/{id}/move:
put:
tags:
- ArticleRestController
summary: 게시글 이동
description: 게시글을 이동합니다
operationId: move
parameters:
- name: id
in: path
description: 게시글 식별자
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveArticleCommand'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntityModelArticle'
/articles:
get:
tags:
- ArticleRestController
summary: 게시글 목록 조회
description: 게시글 목록을 조회합니다
operationId: findAll
parameters:
- name: search
in: query
required: true
schema:
$ref: '#/components/schemas/ArticleSearch'
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PagedModelEntityModelArticle'
post:
tags:
- ArticleRestController
summary: 게시글 생성
description: 게시글을 생성합니다
operationId: create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateArticleCommand'
required: true
responses:
"200":
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntityModelArticle'
components:
schemas:
UpdateArticleCommand:
required:
- content
- title
type: object
properties:
title:
type: string
description: 제목
example: 제목
content:
type: string
description: 제목
example: 본문
description: 게시글 수정 커맨드
EntityModelArticle:
type: object
properties:
id:
type: string
categoryId:
type: string
title:
type: string
content:
type: string
author:
type: string
createdAt:
type: string
format: date-time
modifiedAt:
type: string
format: date-time
_links:
$ref: '#/components/schemas/Links'
Links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
MoveArticleCommand:
required:
- categoryId
type: object
properties:
categoryId:
type: string
description: 카테고리 식별자. 이 필드는 필수입니다.
format: uuid
description: 게시글 이동 커맨드
CreateArticleCommand:
required:
- categoryId
- content
- title
type: object
properties:
title:
type: string
description: 제목. 이 필드는 필수입니다.
example: 제목
content:
type: string
description: 본문. 이 필드는 필수입니다.
example: 본문
categoryId:
type: string
description: 카테고리 식별자. 이 필드는 필수입니다.
format: uuid
description: 게시글 생성 커맨드
ArticleSearch:
type: object
properties:
page:
type: integer
description: 페이지 인덱스
format: int32
example: 0
default: 0
size:
type: integer
description: 페이지 당 출력할 레코드 수
format: int32
example: 10
default: 10
sort:
type: string
description: 정렬할 필드
example: createdAt|updatedAt|id
default: createdAt
sortDirection:
type: string
description: 정렬 방향
example: asc|desc
default: desc
categoryId:
type: string
description: 카테고리 식별자
format: uuid
title:
type: string
description: 제목
example: 제목
content:
type: string
description: 내용
example: 내용
author:
type: string
description: 작성자
example: 작성자
description: 게시글 검색 조건
PageMetadata:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelEntityModelArticle:
type: object
properties:
_embedded:
type: object
properties:
articleList:
type: array
items:
$ref: '#/components/schemas/EntityModelArticle'
_links:
$ref: '#/components/schemas/Links'
page:
$ref: '#/components/schemas/PageMetadata'
Link:
type: object
properties:
href:
type: string
hreflang:
type: string
title:
type: string
type:
type: string
deprecation:
type: string
profile:
type: string
name:
type: string
templated:
type: boolean