capabilities.work

Build an HTTP API

A 4-step recipe with Amazon API Gateway. We can help you get access.

Recipe · 4 steps

Build an HTTP API

with Amazon API Gateway

Stand up an HTTP API with an integration, a route, and a stage.

  1. Create the HTTP API container.
  2. Create the backend integration the route will forward requests to.
  3. Create the route, targeting the integration via the integrations/<id> target reference.
  4. Create a stage to publish the API.
What you'll need to have ready
  • name: Name of the HTTP API.
  • description: Optional description for the API.
  • integrationType: Type of integration (AWS, AWS_PROXY, HTTP, HTTP_PROXY, MOCK).
  • integrationUri: Integration target URI (e.g. a Lambda or HTTP backend).
  • payloadFormatVersion: Payload format version for the integration.
  • routeKey: Route key for the route (e.g. "GET /items").
  • stageName: Name of the stage to publish.
For your developer

Arazzo workflow aws-api-gateway:build-http-api, 4 operations: $sourceDescriptions.apisApi.createApi → CreateIntegration → CreateRoute → CreateStage. Specs on APIs.io.

More recipes with Amazon API Gateway

AWS API Gateway Add a Method and RedeployAWS API Gateway Audit an HTTP API SurfaceAWS API Gateway Build a WebSocket APIAWS API Gateway Create an API Key and Usage PlanAWS API Gateway Decommission an HTTP APIAWS API Gateway Deploy an HTTP API to a New StageAWS API Gateway Inspect a REST API MethodAWS API Gateway Provision a Metered REST APIAWS API Gateway Provision and Deploy a REST APIAWS API Gateway Redeploy a REST API Stage