Create API

Contents:

• Create API
• Create Resource for API
• Create Method for Resource
• Create Stage for API
• Enable Canary for Stage

Create API

Go to API Gateway

• Click Create API

• Choose Build under REST API

• Select New API
• Enter a name in API name
• Select API endpoint type as Regional
• Select IP address type as IPv4
• Click Create API

Create Resource for API

A Resource in API Gateway is a path segment in a REST API. It is combined with an HTTP method to form a complete endpoint that clients can call.

• In the interface of the newly created API, click Create resource

• Enter a name in Resource name
• Enable CORS
• Click Create resource

• Create the following Resources: Devs, PremiumUsers, Users (Enable CORS for each resource).

Create Method for Resource

• Select a Resource (e.g., /Devs) and click Create method

• In the Create method interface, select Method type as GET
• Integration type: Lambda function
• Select the corresponding Lambda Function for the Resource (e.g., choose devFunction for Resource /Devs)
• Click Create method

• Repeat the process to create Methods for the remaining Resources.

Create Stage for API

A Stage in API Gateway is a deployment environment of an API. It has its own configuration, URL endpoint, and stage variables, commonly used to differentiate between dev/test/prod (e.g., prod stage: https://abc123.execute-api.ap-southeast-1.amazonaws.com/prod).

Create Stage in the Resources Interface

• Click Deploy API in the Resources interface.

• In the menu that appears, select New stage in the Stage section.
• Enter a name for the Stage in Stage name (e.g., test)
• Click Deploy

Create Stage in the Stages Interface

• Click Create stage in the Stages interface.

• In the Create stage interface, enter a name in Stage name
• Choose a Deployment in the Deployment section
• In Additional settings, enable Throttling and configure Rate and Burst as desired
• Click Create stage

• After Deploy, you can access the API using the Invoke URL of the methods.

Enable Canary for Stage

A Canary in AWS API Gateway stage is a mechanism that allows you to perform a canary release – deploying a new version of the API to a small portion of traffic before rolling it out to all users.

• In the stage interface, click Canary
• Click Create Canary

• In the Create Canary interface, you can configure options such as Request distribution or Stage cache (in this workshop, cache will not be used for canary).
• Click Create canary