-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
390 lines (390 loc) · 11.7 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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
---
swagger: '2.0'
info:
description: Your first API with Amazon API Gateway. This is a sample API that integrates
via HTTP with our demo Pet Store endpoints
title: PetStore
version: '0.0.1'
schemes:
- https
paths:
"/":
get:
tags:
- pets
description: PetStore HTML web page containing API usage information
consumes:
- application/json
produces:
- text/html
responses:
'200':
description: Successful operation
headers:
Content-Type:
type: string
description: Media type of request
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Content-Type: "'text/html'"
responseTemplates:
text/html: |-
<html>
<head>
<style>
body {
color: #333;
font-family: Sans-serif;
max-width: 800px;
margin: auto;
}
</style>
</head>
<body>
<h1>Welcome to your Pet Store API</h1>
<p>
You have succesfully deployed your first API. You are seeing this HTML page because the <code>GET</code> method to the root resource of your API returns this content as a Mock integration.
</p>
<p>
The Pet Store API contains the <code>/pets</code> and <code>/pets/{petId}</code> resources. By making a <a href="/$context.stage/pets/" target="_blank"><code>GET</code> request</a> to <code>/pets</code> you can retrieve a list of Pets in your API. If you are looking for a specific pet, for example the pet with ID 1, you can make a <a href="/$context.stage/pets/1" target="_blank"><code>GET</code> request</a> to <code>/pets/1</code>.
</p>
<p>
You can use a REST client such as <a href="https://www.getpostman.com/" target="_blank">Postman</a> to test the <code>POST</code> methods in your API to create a new pet. Use the sample body below to send the <code>POST</code> request:
</p>
<pre>
{
"type" : "cat",
"price" : 123.11
}
</pre>
</body>
</html>
passthroughBehavior: when_no_match
requestTemplates:
application/json: '{"statusCode": 200}'
type: mock
"/pets":
get:
tags:
- pets
summary: List all pets
produces:
- application/json
parameters:
- name: type
in: query
description: The type of pet to retrieve
required: false
type: string
- name: page
in: query
description: Page number of results to return.
required: false
type: string
responses:
'200':
description: Successful operation
schema:
"$ref": "#/definitions/Pets"
headers:
Access-Control-Allow-Origin:
type: string
description: URI that may access the resource
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Origin: "'*'"
requestParameters:
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.type: method.request.querystring.type
uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets
passthroughBehavior: when_no_match
httpMethod: GET
type: http
post:
tags:
- pets
operationId: CreatePet
summary: Create a pet
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: NewPet
required: true
schema:
"$ref": "#/definitions/NewPet"
responses:
'200':
description: Successful operation
schema:
"$ref": "#/definitions/NewPetResponse"
headers:
Access-Control-Allow-Origin:
type: string
description: URI that may access the resource
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Origin: "'*'"
uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets
passthroughBehavior: when_no_match
httpMethod: POST
type: http
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
"$ref": "#/definitions/Empty"
headers:
Access-Control-Allow-Origin:
type: string
description: URI that may access the resource
Access-Control-Allow-Methods:
type: string
description: Method or methods allowed when accessing the resource
Access-Control-Allow-Headers:
type: string
description: Used in response to a preflight request to indicate which
HTTP headers can be used when making the request.
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Methods: "'POST,GET,OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key'"
method.response.header.Access-Control-Allow-Origin: "'*'"
passthroughBehavior: when_no_match
requestTemplates:
application/json: '{"statusCode": 200}'
type: mock
"/pets/{petId}":
get:
tags:
- pets
summary: Info for a specific pet
operationId: GetPet
produces:
- application/json
parameters:
- name: petId
in: path
description: The id of the pet to retrieve
required: true
type: string
responses:
'200':
description: Successful operation
schema:
"$ref": "#/definitions/Pet"
headers:
Access-Control-Allow-Origin:
type: string
description: URI that may access the resource
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Origin: "'*'"
requestParameters:
integration.request.path.petId: method.request.path.petId
uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets/{petId}
passthroughBehavior: when_no_match
httpMethod: GET
type: http
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: petId
in: path
description: The id of the pet to retrieve
required: true
type: string
responses:
'200':
description: Successful operation
schema:
"$ref": "#/definitions/Empty"
headers:
Access-Control-Allow-Origin:
type: string
description: URI that may access the resource
Access-Control-Allow-Methods:
type: string
description: Method or methods allowed when accessing the resource
Access-Control-Allow-Headers:
type: string
description: Used in response to a preflight request to indicate which
HTTP headers can be used when making the request.
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Methods: "'GET,OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key'"
method.response.header.Access-Control-Allow-Origin: "'*'"
passthroughBehavior: when_no_match
requestTemplates:
application/json: '{"statusCode": 200}'
type: mock
definitions:
Pets:
type: array
items:
"$ref": "#/definitions/Pet"
Empty:
type: object
NewPetResponse:
type: object
properties:
pet:
"$ref": "#/definitions/Pet"
message:
type: string
Pet:
type: object
properties:
id:
type: string
type:
type: string
price:
type: number
NewPet:
type: object
properties:
type:
"$ref": "#/definitions/PetType"
price:
type: number
PetType:
type: string
enum:
- dog
- cat
- fish
- bird
- gecko
x-amazon-apigateway-documentation:
version: v2.1
createdDate: '2016-11-17T07:03:59Z'
documentationParts:
- location:
type: API
properties:
info:
description: Your first API with Amazon API Gateway. This is a sample API
that integrates via HTTP with our demo Pet Store endpoints
- location:
type: METHOD
method: GET
properties:
tags:
- pets
description: PetStore HTML web page containing API usage information
- location:
type: METHOD
path: "/pets/{petId}"
method: GET
properties:
tags:
- pets
summary: Info for a specific pet
- location:
type: METHOD
path: "/pets"
method: GET
properties:
tags:
- pets
summary: List all pets
- location:
type: METHOD
path: "/pets"
method: POST
properties:
tags:
- pets
summary: Create a pet
- location:
type: PATH_PARAMETER
path: "/pets/{petId}"
method: "*"
name: petId
properties:
description: The id of the pet to retrieve
- location:
type: QUERY_PARAMETER
path: "/pets"
method: GET
name: page
properties:
description: Page number of results to return.
- location:
type: QUERY_PARAMETER
path: "/pets"
method: GET
name: type
properties:
description: The type of pet to retrieve
- location:
type: REQUEST_BODY
path: "/pets"
method: POST
properties:
description: Pet object that needs to be added to the store
- location:
type: RESPONSE
method: "*"
statusCode: '200'
properties:
description: Successful operation
- location:
type: RESPONSE_HEADER
method: OPTIONS
statusCode: '200'
name: Access-Control-Allow-Headers
properties:
description: Used in response to a preflight request to indicate which HTTP
headers can be used when making the request.
- location:
type: RESPONSE_HEADER
method: OPTIONS
statusCode: '200'
name: Access-Control-Allow-Methods
properties:
description: Method or methods allowed when accessing the resource
- location:
type: RESPONSE_HEADER
method: "*"
statusCode: '200'
name: Access-Control-Allow-Origin
properties:
description: URI that may access the resource
- location:
type: RESPONSE_HEADER
method: GET
statusCode: '200'
name: Content-Type
properties:
description: Media type of request