-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
215 lines (214 loc) · 5.2 KB
/
swagger.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
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
openapi: 3.0.0
info:
title: News CRUD API
description: API para gerenciar notícias
version: 1.0.0
servers:
- url: http://localhost:3333
paths:
/news:
get:
summary: Listar todas as notícias
responses:
'200':
description: Lista de notícias
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Notice'
post:
summary: Criar uma nova notícia
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- title
- body
- author
properties:
title:
type: string
body:
type: string
author:
type: string
responses:
'201':
description: Notícia criada
content:
application/json:
schema:
$ref: '#/components/schemas/Notice'
'400':
description: Erro de validação
content:
application/json:
schema:
type: object
properties:
error:
type: string
/news/{id}:
get:
summary: Obter uma notícia por ID
parameters:
- name: id
in: path
required: true
description: ID da notícia
schema:
type: integer
responses:
'200':
description: Notícia encontrada
content:
application/json:
schema:
$ref: '#/components/schemas/Notice'
'404':
description: Notícia não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
put:
summary: Atualizar uma notícia existente
parameters:
- name: id
in: path
required: true
description: ID da notícia
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- title
- body
- author
properties:
title:
type: string
body:
type: string
author:
type: string
responses:
'200':
description: Notícia atualizada
content:
application/json:
schema:
$ref: '#/components/schemas/Notice'
'404':
description: Notícia não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
'400':
description: Erro de validação
content:
application/json:
schema:
type: object
properties:
error:
type: string
delete:
summary: Deletar uma notícia por ID
parameters:
- name: id
in: path
required: true
description: ID da notícia
schema:
type: integer
responses:
'204':
description: Notícia deletada
'404':
description: Notícia não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
/presigned-url:
post:
summary: Generate presigned URL for image upload
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- fileName
- fileSize
- contentType
properties:
fileName:
type: string
fileSize:
type: number
contentType:
type: string
responses:
'200':
description: Upload URLs generated
content:
application/json:
schema:
type: object
properties:
uploadUrl:
type: string
publicUrl:
type: string
'400':
description: Validation error
'401':
description: Unauthorized
components:
schemas:
Notice:
type: object
properties:
id:
type: integer
title:
type: string
body:
type: string
author:
type: string
createdAt:
type: string
format: date-time
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- bearerAuth: []