API deployment and stages in AWS - Step-by-Step Execution

Process Flow - API deployment and stages

Create API Definition

↓

Deploy API to Stage

↓

Stage Created with URL

↓

Client Calls Stage URL

↓

API Gateway Routes Request

↓

Backend Service Responds

↓

Response Returned to Client

This flow shows how an API is created, deployed to a stage, and then accessed by clients through that stage URL.

Execution Sample

AWS

aws apigateway create-rest-api --name MyAPI
aws apigateway create-deployment --rest-api-id abc123 --stage-name prod
curl https://abc123.execute-api.region.amazonaws.com/prod/resource

Creates an API, deploys it to a 'prod' stage, and calls the deployed API endpoint.

Process Table

Step	Action	Input/Parameters	Result/Output	Notes
1	Create API	Name=MyAPI	API ID=abc123	API created with unique ID
2	Create Deployment	API ID=abc123, Stage=prod	Deployment ID=dep456, Stage URL=https://abc123.execute-api.region.amazonaws.com/prod	API deployed to 'prod' stage
3	Client Call	URL=https://abc123.execute-api.region.amazonaws.com/prod/resource	Request routed to backend, Response=200 OK	Client accesses deployed API
4	Update API	Add new resource or method	API definition updated	Changes made but not live until redeployed
5	Create New Deployment	API ID=abc123, Stage=prod	Deployment ID=dep789, Stage URL unchanged	New deployment updates stage with latest API
6	Client Call	URL=https://abc123.execute-api.region.amazonaws.com/prod/resource	Request routed to updated backend, Response=200 OK	Client accesses updated API
7	Exit	No further deployments	API stable at 'prod' stage	Execution stops as no new deployments

💡 No new deployments created, API stage remains stable

Status Tracker

Variable	Start	After Step 1	After Step 2	After Step 4	After Step 5	Final
API ID	None	abc123	abc123	abc123	abc123	abc123
Deployment ID	None	None	dep456	dep456	dep789	dep789
Stage Name	None	None	prod	prod	prod	prod
Stage URL	None	None	https://abc123.execute-api.region.amazonaws.com/prod	https://abc123.execute-api.region.amazonaws.com/prod	https://abc123.execute-api.region.amazonaws.com/prod	https://abc123.execute-api.region.amazonaws.com/prod
API Definition	Empty	Created	Created	Updated	Updated	Updated

Key Moments - 2 Insights

Why does updating the API definition not immediately change the live API?

Because the API must be redeployed to a stage after updates. See step 4 and 5 in the execution_table where the API is updated but only after step 5 deployment does the stage reflect changes.

What is the purpose of stages in API deployment?

Stages provide separate deployment environments (like 'prod' or 'dev') with unique URLs. This lets you test changes in one stage without affecting others. The execution_table shows deployment to 'prod' stage creating a stage URL.

Visual Quiz - 3 Questions

Look at the execution_table, what is the Deployment ID after the first deployment?

A dep456

B abc123

C dep789

D prod

💡 Hint

Check the 'Result/Output' column in step 2 of the execution_table.

At which step does the API stage URL become available?

A Step 4

B Step 1

C Step 2

D Step 5

💡 Hint

Look for when the 'Stage URL' is first shown in the execution_table.

If you update the API but do not create a new deployment, what happens when clients call the stage URL?

A They get the updated API response

B They get the old API response

C They get an error

D The stage URL changes

💡 Hint

Refer to steps 4 and 5 in the execution_table and variable_tracker for API Definition and Deployment ID.

Concept Snapshot

API Deployment and Stages:
- Create API to get API ID
- Deploy API to a stage (e.g., 'prod') to get a stage URL
- Clients call the stage URL to access the API
- Updating API requires redeployment to update the stage
- Stages isolate environments for testing and production

Full Transcript

This visual execution traces the process of deploying an API in AWS API Gateway. First, an API is created and assigned an ID. Then, the API is deployed to a stage, which creates a unique URL for clients to call. Clients use this URL to send requests that API Gateway routes to backend services. When the API definition changes, these changes do not affect the live stage until a new deployment is created. Stages allow separation of environments like development and production. The execution table shows each step, including creating the API, deploying it, client calls, updating the API, and redeploying. Variable tracking shows how API ID, deployment ID, stage name, and URL evolve. Key moments clarify why redeployment is needed and the role of stages. The quiz tests understanding of deployment IDs, stage URL availability, and behavior when redeployment is skipped.