-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathapi_gateway.yaml
305 lines (305 loc) · 7 KB
/
api_gateway.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
swagger: "2.0"
info:
description: This is a microservice that is the users' gateway to other microservices.
version: "1.0.0"
title: "API Gateway"
host: "127.0.0.1:80"
basePath: "/"
tags:
- name: "user"
description: "Operations on users"
schemes:
- "http"
paths:
/#:
post:
tags:
- "user"
summary: "Sign new users up"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: true
schema:
type: object
required:
- username
- password
- isAdmin
properties:
username:
type: string
password:
type: string
email:
type: string
phone:
type: string
isAdmin:
type: boolean
responses:
"201":
description: "Created"
schema:
type: "object"
properties:
message:
type: string
'400':
description: 'Bad request'
schema:
type: "object"
properties:
message:
type: string
"409":
description: "User already exists"
schema:
type: "object"
properties:
message:
type: string
/#:
post:
tags:
- "user"
summary: "Login for users"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: true
schema:
type: object
required:
- username
- password
properties:
username:
type: string
password:
type: string
responses:
"200":
description: "Ok"
schema:
type: "object"
properties:
message:
type: string
token:
type: string
'400':
description: 'Bad request'
schema:
type: "object"
properties:
message:
type: string
"401":
description: 'Unauthorized'
schema:
type: "object"
properties:
message:
type: string
/show_profile/{username}:
get:
tags:
- "user"
summary: "Return user information + posts"
produces:
- "application/json"
parameters:
- in: path
name: username
type: string
required: true
responses:
"200":
description: "Ok"
schema:
type: "object"
properties:
posts:
type: "array"
items:
type: object
properties:
id:
type: string
username:
type: string
title:
type: string
body:
type: string
username:
type: string
email:
type: string
phone:
type: string
isAdmin:
type: boolean
"401":
description: 'Unauthorized'
schema:
type: "object"
properties:
message:
type: string
"404":
description: "User not found"
schema:
type: "object"
properties:
message:
type: "string"
security:
- Bearer: [ ]
/update_profile/{username}:
post:
tags:
- "user"
summary: "Modify user information"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: path
name: 'username'
type: string
required: true
- in: "body"
name: "body"
required: True
schema:
type: "object"
properties:
username:
type: string
password:
type: string
email:
type: string
phone:
type: string
isAdmin:
type: boolean
responses:
"200":
description: "Successful update"
schema:
type: "object"
properties:
message:
type: "string"
"400":
description: "Bad request"
schema:
type: "object"
properties:
message:
type: "string"
"401":
description: 'Unauthorized'
schema:
type: "object"
properties:
message:
type: string
"404":
description: "User not found"
schema:
type: "object"
properties:
message:
type: "string"
security:
- Bearer: [ ]
/posts:
post:
tags:
- "post"
summary: "Create new post (only for normal users)"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
required: True
schema:
type: "object"
properties:
title:
type: string
body:
type: string
responses:
"200":
description: "Successful update"
security:
- Bearer: [ ]
/posts/{post_id}:
delete:
tags:
- "post"
summary: "Delete a post"
produces:
- "application/json"
parameters:
- in: path
name: post_id
type: integer
required: true
responses:
"204":
description: "Deleted"
schema:
type: "object"
"404":
description: "User not found"
schema:
type: "object"
properties:
message:
type: "string"
/explore:
get:
tags:
- "post"
summary: "View timeline (all posts + user info)"
produces:
- "application/json"
responses:
"200":
description: "Successful fetch"
schema:
type: "array"
items:
type: object
properties:
id:
type: string
username:
type: string
title:
type: string
body:
type: string
securityDefinitions:
Bearer:
type: apiKey
name: Authorization
in: header