@aws-sdk/client-apigatewayv2

What is @aws-sdk/client-apigatewayv2?

@aws-sdk/client-apigatewayv2 is a part of the AWS SDK for JavaScript, which allows developers to interact with the Amazon API Gateway V2 service. This package provides a set of APIs to create, configure, and manage API Gateway resources, including HTTP APIs, WebSocket APIs, and their integrations, routes, and stages.

What are @aws-sdk/client-apigatewayv2's main functionalities?

Create an HTTP API

This feature allows you to create a new HTTP API. The code sample demonstrates how to use the CreateApiCommand to create an HTTP API named 'MyHttpApi' in the 'us-west-2' region.

const { ApiGatewayV2Client, CreateApiCommand } = require('@aws-sdk/client-apigatewayv2');

const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
  Name: 'MyHttpApi',
  ProtocolType: 'HTTP'
};

const run = async () => {
  try {
    const data = await client.send(new CreateApiCommand(params));
    console.log('API Created', data);
  } catch (err) {
    console.error(err);
  }
};

run();

Create a WebSocket API

This feature allows you to create a new WebSocket API. The code sample demonstrates how to use the CreateApiCommand to create a WebSocket API named 'MyWebSocketApi' with a route selection expression in the 'us-west-2' region.

const { ApiGatewayV2Client, CreateApiCommand } = require('@aws-sdk/client-apigatewayv2');

const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
  Name: 'MyWebSocketApi',
  ProtocolType: 'WEBSOCKET',
  RouteSelectionExpression: '$request.body.action'
};

const run = async () => {
  try {
    const data = await client.send(new CreateApiCommand(params));
    console.log('WebSocket API Created', data);
  } catch (err) {
    console.error(err);
  }
};

run();

Create an Integration

This feature allows you to create an integration for an API. The code sample demonstrates how to use the CreateIntegrationCommand to create an AWS_PROXY integration with a Lambda function for a specified API.

const { ApiGatewayV2Client, CreateIntegrationCommand } = require('@aws-sdk/client-apigatewayv2');

const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
  ApiId: 'api-id',
  IntegrationType: 'AWS_PROXY',
  IntegrationUri: 'arn:aws:lambda:us-west-2:123456789012:function:my-function',
  PayloadFormatVersion: '2.0'
};

const run = async () => {
  try {
    const data = await client.send(new CreateIntegrationCommand(params));
    console.log('Integration Created', data);
  } catch (err) {
    console.error(err);
  }
};

run();

Create a Route

This feature allows you to create a route for an API. The code sample demonstrates how to use the CreateRouteCommand to create a route with a specified route key and target integration for a given API.

const { ApiGatewayV2Client, CreateRouteCommand } = require('@aws-sdk/client-apigatewayv2');

const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
  ApiId: 'api-id',
  RouteKey: 'GET /myroute',
  Target: 'integrations/integration-id'
};

const run = async () => {
  try {
    const data = await client.send(new CreateRouteCommand(params));
    console.log('Route Created', data);
  } catch (err) {
    console.error(err);
  }
};

run();

Deploy an API

This feature allows you to deploy an API to a specified stage. The code sample demonstrates how to use the CreateDeploymentCommand to deploy an API to the 'dev' stage.

const { ApiGatewayV2Client, CreateDeploymentCommand } = require('@aws-sdk/client-apigatewayv2');

const client = new ApiGatewayV2Client({ region: 'us-west-2' });
const params = {
  ApiId: 'api-id',
  StageName: 'dev'
};

const run = async () => {
  try {
    const data = await client.send(new CreateDeploymentCommand(params));
    console.log('API Deployed', data);
  } catch (err) {
    console.error(err);
  }
};

run();

Other packages similar to @aws-sdk/client-apigatewayv2

serverless

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-apigatewayv2, Serverless Framework offers more features for deployment automation and infrastructure as code.

aws-cdk

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 provides a higher-level abstraction for managing AWS resources, including API Gateway. Compared to @aws-sdk/client-apigatewayv2, AWS CDK offers a more comprehensive and integrated approach to infrastructure management and deployment.

claudia

Claudia.js is a tool for deploying Node.js projects to AWS Lambda and API Gateway. It simplifies the process of creating and managing serverless APIs by automating the deployment and configuration steps. Compared to @aws-sdk/client-apigatewayv2, Claudia.js focuses on ease of use and rapid deployment for Node.js applications.

README

@aws-sdk/client-apigatewayv2

For SDK usage, please step to SDK reademe.