Generate the JavaScript SDK of a REST API

Old REST API console

Note

We've redesigned the API Gateway console. The old console experience will no longer be available starting December 2023.

To generate the JavaScript SDK of an API in API Gateway

1. Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.

2. In the list of APIs, choose the name of the API that you want to generate the SDK for.

3. In the pane on the left that contains the name of the API, choose Stages.

4. In the Stages pane, choose the name of the stage.

5. On the SDK Generation tab, for Platform, choose JavaScript.

6. Choose Generate SDK, and then follow the on-screen directions to download the SDK generated by API Gateway.

New REST API console

To generate the JavaScript SDK of an API in API Gateway

1. Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.

2. Choose a REST API.

3. Choose Stages.

4. In the Stages pane, select the name of the stage.

5. Open the Stage actions menu, and then choose Generate SDK.

6. For Platform, choose the JavaScript platform.

7. Choose Generate SDK, and then follow the on-screen directions to download the SDK generated by API Gateway.

Follow the instructions in Use a JavaScript SDK generated by API Gateway for a REST API to use the generated SDK.

Every time you update an API, you must redeploy the API and regenerate the SDK to have the updates included.