forked from 2024-gbsw-lecture/spring-lecture
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlevel-2-article-with-password-open-api.yml
160 lines (153 loc) · 3.92 KB
/
level-2-article-with-password-open-api.yml
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
openapi: 3.0.0
info:
title: 게시물 관리 API
description: 게시물을 생성, 검색, 갱신 및 삭제하기 위한 API.
version: 1.0.0
servers:
- url: http://localhost:8080
description: 개발 서버 (로컬 데이터 사용)
paths:
/articles/:
get:
summary: 게시물 목록 검색
description: 등록된 모든 게시물의 목록을 검색합니다.
responses:
'200':
description: 게시물 목록
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
post:
summary: 새 게시물 생성
description: 새로운 게시물을 생성합니다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostCreate'
responses:
'200':
description: 게시물 생성됨
'401':
description: 비밀번호 오류
/articles/{id}:
get:
summary: ID로 게시물 검색
description: 특정 ID를 가진 게시물을 검색합니다.
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: 게시물 상세 정보
content:
application/json:
schema:
$ref: '#/components/schemas/Post'
'404':
description: 게시물을 찾을 수 없음
put:
summary: 게시물 갱신
description: 특정 게시물의 내용을 갱신합니다.
parameters:
- name: id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostUpdate'
responses:
'200':
description: 게시물 갱신됨
'401':
description: 비밀번호 오류
delete:
summary: 게시물 삭제
description: 특정 게시물을 삭제합니다.
parameters:
- name: id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
example: "비밀번호"
responses:
'200':
description: 게시물 삭제됨
'401':
description: 비밀번호 오류
'404':
description: 게시물을 찾을 수 없음
components:
schemas:
Post:
type: object
properties:
id:
type: integer
example: 1
title:
type: string
example: "반갑다"
content:
type: string
example: "반갑다"
author:
type: string
example: "김대용"
createdAt:
type: string
format: date-time
example: "2023-12-31T06:31:49"
updatedAt:
type: string
format: date-time
example: "2023-12-31T06:31:49"
PostCreate:
type: object
properties:
title:
type: string
example: "새 게시물 제목"
content:
type: string
example: "새 게시물 내용"
author:
type: string
example: "작성자 이름"
password:
type: string
example: "비밀번호"
PostUpdate:
type: object
properties:
title:
type: string
example: "갱신된 게시물 제목"
content:
type: string
example: "갱신된 게시물 내용"
password:
type: string
example: "비밀번호"