-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapispec.yml
166 lines (166 loc) · 3.93 KB
/
apispec.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
openapi: "3.0.2"
info:
title: REST API
description: Rest API with GOLANG
version: "1.0.0"
servers:
- url: https://5zd9cgfl-3000.asse.devtunnels.ms/api
paths:
/categories:
get:
security:
- CategoryAuth: []
tags:
- "Category API"
summary: Get all categories
description: Get all categories
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
code:
type: number
status:
type: string
data:
type: array
items:
$ref: "#/components/schemas/Category"
post:
security:
- CategoryAuth: []
tags:
- "Category API"
summary: Create a new category
description: Create a new category
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
code:
type: number
status:
type: string
data:
$ref: "#/components/schemas/Category"
/categories/{id}:
get:
security:
- CategoryAuth: []
tags:
- "Category API"
summary: Get a category by ID
description: Get a category by ID
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
code:
type: number
status:
type: string
data:
$ref: "#/components/schemas/Category"
put:
security:
- CategoryAuth: []
tags:
- "Category API"
summary: Update a category by ID
description: Update a category by ID
parameters:
- in: path
name: id
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
code:
type: number
status:
type: string
data:
$ref: "#/components/schemas/Category"
delete:
security:
- CategoryAuth: []
tags:
- "Category API"
summary: Delete a category by ID
description: Delete a category by ID
parameters:
- in: path
name: id
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
code:
type: number
status:
type: string
components:
securitySchemes:
CategoryAuth:
type: apiKey
in: header
name: X-API-Key
description: API Key for Category API
schemas:
Category:
type: object
properties:
id:
type: number
name:
type: string