Set up an edge-optimized API by importing OpenAPI definitions
You can set up an API in API Gateway by specifying OpenAPI definitions of appropriate API Gateway API entities and importing the OpenAPI definitions into API Gateway.
The following OpenAPI definitions describe the simple API, exposing only the
GET /
method integrated with an HTTP endpoint of the PetStore
website in the backend, and returning a 200 OK
response.
The following procedure describes how to import these OpenAPI definitions into API Gateway using the API Gateway console.
To import the simple OpenAPI definitions using the API Gateway console
-
Sign in to the API Gateway console at https://console.amazonaws.cn/apigateway
. -
Choose Create API, and then for REST API, choose Import.
-
If you saved the preceding OpenAPI definitions in a file, choose Choose file. You can also copy the OpenAPI definitions and paste them into the import text editor.
For API endpoint type, select Edge-optimized.
-
Choose Create API to import the OpenAPI definitions.
To import the OpenAPI definitions using the Amazon CLI, save the OpenAPI definitions
into a file and then run the following command, assuming that you use the
us-west-2
region and the absolute OpenAPI file path is
file:///path/to/API_OpenAPI_template.json
:
aws apigateway import-rest-api --body 'file:///path/to/API_OpenAPI_template.json' --region us-west-2