@aws-sdk/client-api-gateway
Advanced tools
AWS SDK for JavaScript Api Gateway Client for Node.js, Browser and React Native
@aws-sdk/client-api-gateway is a part of the AWS SDK for JavaScript, which allows developers to interact with the Amazon API Gateway service. This package provides a set of tools to create, deploy, and manage APIs at any scale.
Create a new API
This feature allows you to create a new REST API in Amazon API Gateway. The code sample demonstrates how to create a new API named 'MyAPI' using the APIGatewayClient and CreateRestApiCommand.
const { APIGatewayClient, CreateRestApiCommand } = require('@aws-sdk/client-api-gateway');
const client = new APIGatewayClient({ region: 'us-west-2' });
const command = new CreateRestApiCommand({ name: 'MyAPI' });
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Deploy an API
This feature allows you to deploy an API to a specific stage. The code sample demonstrates how to deploy an API to the 'prod' stage using the APIGatewayClient and CreateDeploymentCommand.
const { APIGatewayClient, CreateDeploymentCommand } = require('@aws-sdk/client-api-gateway');
const client = new APIGatewayClient({ region: 'us-west-2' });
const command = new CreateDeploymentCommand({ restApiId: 'your-rest-api-id', stageName: 'prod' });
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Create a resource
This feature allows you to create a new resource under an existing API. The code sample demonstrates how to create a new resource named 'myresource' under a specified parent resource using the APIGatewayClient and CreateResourceCommand.
const { APIGatewayClient, CreateResourceCommand } = require('@aws-sdk/client-api-gateway');
const client = new APIGatewayClient({ region: 'us-west-2' });
const command = new CreateResourceCommand({ restApiId: 'your-rest-api-id', parentId: 'your-parent-id', pathPart: 'myresource' });
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Create a method
This feature allows you to create a new method for a resource. The code sample demonstrates how to create a GET method with no authorization for a specified resource using the APIGatewayClient and PutMethodCommand.
const { APIGatewayClient, PutMethodCommand } = require('@aws-sdk/client-api-gateway');
const client = new APIGatewayClient({ region: 'us-west-2' });
const command = new PutMethodCommand({ restApiId: 'your-rest-api-id', resourceId: 'your-resource-id', httpMethod: 'GET', authorizationType: 'NONE' });
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);The Serverless Framework is a popular open-source framework for building and deploying serverless applications. It supports multiple cloud providers, including AWS, and provides a higher-level abstraction for managing API Gateway resources. Compared to @aws-sdk/client-api-gateway, Serverless Framework offers more features and simplifies the deployment process but may not provide the same level of granular control.
The AWS Cloud Development Kit (CDK) is an open-source software development framework for defining cloud infrastructure in code and provisioning it through AWS CloudFormation. It allows you to define API Gateway resources using higher-level constructs. Compared to @aws-sdk/client-api-gateway, AWS CDK provides a more abstracted and code-centric approach to managing infrastructure, making it easier to define and deploy complex architectures.
Claudia.js is a tool for deploying Node.js projects to AWS Lambda and API Gateway. It automates many of the deployment tasks and provides a simple way to create and manage APIs. Compared to @aws-sdk/client-api-gateway, Claudia.js focuses on simplifying the deployment process and is particularly well-suited for developers who want to quickly deploy serverless applications without dealing with the intricacies of API Gateway.
AWS SDK for JavaScript APIGateway Client for Node.js, Browser and React Native.
Amazon API Gateway
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
To install the this package, simply type add or install @aws-sdk/client-api-gateway using your favorite package manager:
npm install @aws-sdk/client-api-gatewayyarn add @aws-sdk/client-api-gatewaypnpm add @aws-sdk/client-api-gatewayThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the APIGatewayClient and
the commands you need, for example CreateApiKeyCommand:
// ES5 example
const { APIGatewayClient, CreateApiKeyCommand } = require("@aws-sdk/client-api-gateway");
// ES6+ example
import { APIGatewayClient, CreateApiKeyCommand } from "@aws-sdk/client-api-gateway";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new APIGatewayClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new CreateApiKeyCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// proccess err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-api-gateway";
const client = new AWS.APIGateway({ region: "REGION" });
// async/await.
try {
const data = await client.createApiKey(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.createApiKey(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.createApiKey(params, (err, data) => {
// proccess err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-api-gateway package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.18.0 (2021-06-04)
FAQs
AWS SDK for JavaScript Api Gateway Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-api-gateway receives a total of 134,967 weekly downloads. As such, @aws-sdk/client-api-gateway popularity was classified as popular.
We found that @aws-sdk/client-api-gateway demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.