-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathhexagonal-architecture-api.openapi.json
228 lines (228 loc) · 5.54 KB
/
hexagonal-architecture-api.openapi.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
{
"openapi": "3.0.0",
"info": {
"title": "Hexagonal Architecture API",
"description": "Hexagonal Architecture in Java",
"contact": {
"email": "you@your-company.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"servers": [
{
"url": "http://localhost:8080/api/v1",
"description": "SwaggerHub API Auto Mocking"
}
],
"tags": [
{
"name": "admins",
"description": "Secured Admin-only calls"
},
{
"name": "developers",
"description": "Operations available to regular developers"
}
],
"paths": {
"/product": {
"get": {
"tags": [
"developers"
],
"summary": "Find all products",
"description": "By passing in the appropriate options, you can search for\navailable product in the system\n",
"operationId": "searchProduct",
"responses": {
"200": {
"description": "search results matching criteria",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
}
}
},
"400": {
"description": "bad input parameter"
}
}
},
"post": {
"tags": [
"developers"
],
"summary": "Creates a product",
"description": "Adds a product to the system",
"operationId": "addProduct",
"requestBody": {
"description": "Product to add",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"responses": {
"201": {
"description": "product created",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
}
}
},
"400": {
"description": "invalid input, object invalid"
},
"409": {
"description": "an existing product already exists"
}
}
}
},
"/product/{productId}": {
"get": {
"tags": [
"developers"
],
"summary": "Find product by Id",
"description": "Returns a single product",
"operationId": "getProductById",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "Pass an product id for looking up products",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "search results matching criteria",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Product not found"
}
}
},
"delete": {
"tags": [
"developers"
],
"summary": "Delete a product by Id",
"description": "Deletes a single product",
"operationId": "deleteProduct",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "Pass an product id for looking up products",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "search results matching criteria",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Product not found"
}
}
}
}
},
"components": {
"schemas": {
"Product": {
"required": [
"description",
"productId",
"type"
],
"type": "object",
"properties": {
"productId": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "Laptop"
},
"releaseDate": {
"type": "string",
"example": "Lenovo Thinkpad"
}
}
},
"ProductMobile": {
"required": [
"description",
"productId",
"type"
],
"type": "object",
"properties": {
"productId": {
"type": "integer",
"example": 5
},
"type": {
"type": "string",
"example": "Mobile Phone"
},
"releaseDate": {
"type": "string",
"example": "Apple iPhone 11"
}
}
}
}
}
}