AWS API Gateway

You can now connect to Amazon API Gateway from the Postman API Builder. After you connect your API to API Gateway, you can view stage information and deployment history on the Deployments tab in the API Builder. OpenAPI 3.0 schemas for both HTTP and REST APIs are supported. In addition, for HTTP APIs, you can export your schema from Postman to API Gateway for later deployment, or even deploy your HTTP API schema directly from Postman to a stage in API Gateway.

To learn more about connecting your API in Postman to Amazon API Gateway, see Deploying an API.

You can upload your API schemas directly to AWS API Gateway from Postman with this integration. This integration uses version 2 of the AWS API and only supports HTTP APIs with OpenAPI 3.0 schemas.

Contents

Uploading API schemas to AWS API Gateway

You can directly upload your API schemas from Postman to AWS API Gateway. Once the integration is configured, any new changes to your schema in Postman will also appear in your AWS API Gateway.

Configuring an AWS API Gateway integration

  1. Select Home.

    postman home

  2. Select Integrations.

    postman integrations

  3. Search and select AWS API Gateway.

  4. Select Add Integration.

    aws gateway add integration

  5. Enter your AWS access key ID, secret access key, and region, select Continue.

    Learn how to get your AWS credentials.

    aws gateway auth and proceed

  6. Select your API, API version, and the API Gateway you'd like to deploy to from the dropdown menus. You can use an existing API Gateway, or create a new one by selecting Create New API Gateway from the dropdown.

    If you are creating a new API Gateway, auto-deployment will automatically be set to false in AWS.

    aws gateway create

    You can have one AWS API Gateway integration configured for each API version.

To confirm this integration, navigate to your AWS Gateway dashboard, select your API Gateway, then select Integrations to view your newly uploaded endpoints.

Configured integration in AWS

This integration will be triggered whenever the configured Postman schema is updated. Any configured AWS integrations will be preserved.

Note that if the API or specific API version is deleted, its configured integration will also be deleted.

Tracking API deployments with AWS API Gateway

You can also track your AWS API Gateway deployments in Postman via the Deployments tab. See Deploying an API for details.

Next steps

Learn more about other Postman integrations, including custom webhooks and Slack.

Last modified: 2022/01/05