-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenapi.yaml
198 lines (198 loc) · 4.76 KB
/
openapi.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
openapi: 3.0.0
info:
version: 1.0.0
title: Swagger Backend Ecommerce Store Springboot
description: API to obtain data required to make the Ecommerce Application functional
termsOfService: http://swagger.io/terms/
contact:
name: Victor Garcia Rubio
email: [email protected]
url: https://victorgarciar.com
license:
name: MIT
url: https://choosealicense.com/licenses/mit/
servers:
- url: https://springboot-ecommerce-app.herokuapp.com/
paths:
/states:
get:
summary: Get list of states
description: Get list of states
operationId: getStates
parameters:
- name: code
in: query
description: country code to get states
required: false
style: form
schema:
type: string
responses:
'200':
description: State response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/State'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/countries:
get:
summary: Get list of countries
description: Get list of countries
operationId: getCountries
responses:
'200':
description: Country response
content:
application/json:
schema:
$ref: '#/components/schemas/Country'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/product-category:
get:
summary: Get list of product categories
description: Get list of product categories
operationId: getProductCategories
responses:
'200':
description: Product Category list response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProductCategory'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/products:
get:
summary: Get list of products
description: Get list of products
operationId: getProducts
parameters:
- name: id
in: query
description: category id to filter products
required: false
style: form
schema:
type: string
- name: name
in: query
description: name of product to filter
required: false
style: form
schema:
type: string
responses:
'200':
description: Product response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Product'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
State:
type: object
required:
- id
properties:
id:
type: integer
format: int64
name:
type: string
country_id:
type: integer
Country:
type: object
required:
- id
properties:
id:
type: integer
format: int64
minimum: 1
code:
type: string
name:
type: string
ProductCategory:
type: object
properties:
id:
type: integer
minimum: 1
categoryName:
type: string
products:
type: array
items:
$ref: '#/components/schemas/Product'
Product:
type: object
properties:
id:
type: integer
minimum: 1
category:
type: integer
minimum: 1
sku:
type: string
name:
type: string
description:
type: string
unitPrice:
type: number
imageUrl:
type: string
format: uri
active:
type: boolean
unitsInStock:
type: integer
minimum: 0
dateCreated:
type: string
format: datetime
lastUpdated:
type: string
format: datetime
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string