-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathswagger.yaml
369 lines (369 loc) · 8.25 KB
/
swagger.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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
definitions:
app.Response:
properties:
code:
type: integer
data:
type: object
msg:
type: string
type: object
info:
contact: {}
description: An example of gin
license:
name: MIT
url: https://github.com/EDDYCJY/go-gin-example/blob/master/LICENSE
termsOfService: https://github.com/EDDYCJY/go-gin-example
title: Golang Gin API
version: "1.0"
paths:
/api/v1/articles:
get:
parameters:
- description: TagID
in: body
name: tag_id
schema:
type: integer
- description: State
in: body
name: state
schema:
type: integer
- description: CreatedBy
in: body
name: created_by
schema:
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Get multiple articles
post:
parameters:
- description: TagID
in: body
name: tag_id
required: true
schema:
type: integer
- description: Title
in: body
name: title
required: true
schema:
type: string
- description: Desc
in: body
name: desc
required: true
schema:
type: string
- description: Content
in: body
name: content
required: true
schema:
type: string
- description: CreatedBy
in: body
name: created_by
required: true
schema:
type: string
- description: State
in: body
name: state
required: true
schema:
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Add article
/api/v1/articles/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Delete article
get:
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Get a single article
put:
parameters:
- description: ID
in: path
name: id
required: true
type: integer
- description: TagID
in: body
name: tag_id
schema:
type: string
- description: Title
in: body
name: title
schema:
type: string
- description: Desc
in: body
name: desc
schema:
type: string
- description: Content
in: body
name: content
schema:
type: string
- description: ModifiedBy
in: body
name: modified_by
required: true
schema:
type: string
- description: State
in: body
name: state
schema:
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Update article
/api/v1/tags:
get:
parameters:
- description: Name
in: query
name: name
type: string
- description: State
in: query
name: state
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Get multiple article tags
post:
parameters:
- description: Name
in: body
name: name
required: true
schema:
type: string
- description: State
in: body
name: state
schema:
type: integer
- description: CreatedBy
in: body
name: created_by
schema:
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Add article tag
/api/v1/tags/{id}:
delete:
parameters:
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Delete article tag
put:
parameters:
- description: ID
in: path
name: id
required: true
type: integer
- description: Name
in: body
name: name
required: true
schema:
type: string
- description: State
in: body
name: state
schema:
type: integer
- description: ModifiedBy
in: body
name: modified_by
required: true
schema:
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Update article tag
/api/v1/tags/export:
post:
parameters:
- description: Name
in: body
name: name
schema:
type: string
- description: State
in: body
name: state
schema:
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Export article tag
/api/v1/tags/import:
post:
parameters:
- description: Image File
in: formData
name: image
required: true
type: file
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Import Image
/auth:
get:
parameters:
- description: userName
in: query
name: username
required: true
type: string
- description: password
in: query
name: password
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/app.Response'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/app.Response'
summary: Get Auth
swagger: "2.0"