-
Notifications
You must be signed in to change notification settings - Fork 10
/
swagger.json
299 lines (299 loc) · 9.03 KB
/
swagger.json
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
{
"consumes": ["application/json"],
"produces": ["application/json"],
"schemes": ["http", "https"],
"swagger": "2.0",
"info": {
"description": "simple restapi with golang in backend and mongodb as db.",
"title": "Golang RestApi With MongoDB",
"version": "1.0.0"
},
"paths": {
"/person": {
"post": {
"operationId": "create-person",
"summary": "Create Person",
"produces": ["application/json"],
"tags": ["Person Api"],
"parameters": [
{
"name": "body",
"in": "body",
"description": "http request body must be a json format",
"required": true,
"schema": {
"$ref": "#/definitions/Person"
}
}
],
"responses": {
"201": {
"description": "201 create person is successful",
"examples": {
"application/json": "{\n \"status\": 201,\n \"message\": \"\",\n \"content\": {\n\t \"_id\": \"5dceb75c625f79894eb82a4f\",\n\t \"username\": \"mohammadkatoozi\",\n\t \"email\": \"k2527806@gmail.com\"\n\t}\n}"
},
"schema": {
"properties": {
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"content": {
"$ref": "#/definitions/Person"
}
}
}
},
"406": {
"description": "406 not acceptable(username or email already exists)",
"examples": {
"application/json": "{\n \"status\": 406,\n \"message\": \"Error while inserting data.\",\n \"content\": null \n}"
},
"schema": {
"$ref": "#/definitions/Error"
}
},
"500": {
"description": "500 server internal error",
"examples": {
"application/json": "{\n \"status\": 500,\n \"message\": \"Error while inserting data.\",\n \"content\": null \n}"
},
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"get": {
"operationId": "list-person",
"summary": "List of Persons",
"produces": ["application/json"],
"tags": ["Person Api"],
"responses": {
"200": {
"description": "200 list of persons",
"examples": {
"application/json": "{\n \"status\": 201,\n \"message\": \"\",\n \"content\": \n\t [\n\t\t{\n \t\t\"_id\": \"5dceb75c625f79894eb82a4f\",\n\t\t \"username\": \"mohammadkatoozi\",\n\t\t \"email\": \"k2527806@gmail.com\"\n\t\t},\t\n\t\t{\n \t\t\"_id\": \"5dceb75c625f79894eb82a4f\",\n\t\t \"username\": \"mohammadkatoozi\",\n\t\t \"email\": \"k2527806@gmail.com\"\n\t\t}\n\t]\n}"
},
"schema": {
"properties": {
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"content": {
"type": "array",
"items": {
"$ref": "#/definitions/Person"
}
}
}
}
}
}
}
},
"/person/{id}": {
"get": {
"operationId": "get-person",
"summary": "Get Person",
"produces": ["application/json"],
"tags": ["Person Api"],
"parameters": [
{
"name": "id",
"in": "path",
"description": "person id",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "person exists",
"examples": {
"application/json": "{\n \"status\": 200,\n \"message\": \"\",\n \"content\": {\n\t \"_id\": \"5dceb75c625f79894eb82a4f\",\n\t \"username\": \"mohammadkatoozi\",\n\t \"email\": \"k2527806@gmail.com\"\n\t}\n}"
},
"schema": {
"properties": {
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"content": {
"$ref": "#/definitions/Person"
}
}
}
}
}
},
"put": {
"operationId": "update-person",
"summary": "Update Person",
"produces": ["application/json"],
"tags": ["Person Api"],
"parameters": [
{
"name": "id",
"in": "path",
"description": "person id",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "http request body must be a json format",
"required": true,
"schema": {
"$ref": "#/definitions/Person"
}
}
],
"responses": {
"202": {
"description": "person updated",
"examples": {
"application/json": "{\n \"status\": 202,\n \"message\": \"\",\n \"content\": {\n\t \"_id\": \"5dceb75c625f79894eb82a4f\",\n\t \"username\": \"mohammadkatoozi\",\n\t \"email\": \"k2527806@gmail.com\"\n\t}\n}"
},
"schema": {
"properties": {
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"content": {
"$ref": "#/definitions/Person"
}
}
}
},
"404": {
"description": "person not found",
"examples": {
"application/json": "{\n \"status\": 404,\n \"message\": \"person not found\",\n \"content\": null\n}"
},
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"patch": {
"operationId": "patch-person",
"summary": "Update Person",
"produces": ["application/json"],
"tags": ["Person Api"],
"parameters": [
{
"name": "id",
"in": "path",
"description": "person id",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "http request body must be a json format",
"required": true,
"schema": {
"$ref": "#/definitions/Person"
}
}
],
"responses": {
"202": {
"description": "person updated",
"examples": {
"application/json": "{\n \"status\": 202,\n \"message\": \"\",\n \"content\": {\n\t \"_id\": \"5dceb75c625f79894eb82a4f\",\n\t \"username\": \"mohammadkatoozi\",\n\t \"email\": \"k2527806@gmail.com\"\n\t}\n}"
},
"schema": {
"properties": {
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"content": {
"$ref": "#/definitions/Person"
}
}
}
},
"404": {
"description": "person not found",
"examples": {
"application/json": "{\n \"status\": 404,\n \"message\": \"person not found\",\n \"content\": null\n}"
},
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
}
},
"definitions": {
"Person": {
"required": ["username", "email"],
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier representing a specific person.",
"example": "5dcd702258d90272b062efba"
},
"username": {
"type": "string",
"description": "person username. must be unique",
"example": "john_doe"
},
"email": {
"type": "string",
"description": "person email. must be unique",
"example": "john_doe@gmail.com"
},
"first_name": {
"type": "string",
"description": "person first name",
"example": "John"
},
"last_name": {
"type": "string",
"description": "person last name",
"example": "Doe"
},
"data": {
"type": "object",
"description": "data is a placeholder for saving more data about person. any data can be passin in with key:value format",
"example": {
"age": "21"
}
}
}
},
"Error": {
"properties": {
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"content": {
"type": "object"
}
}
}
}
}