https://github.com/kbrashears5/typescript-aws-apigateway-helper

Typescript AWS API Gateway Helper
https://github.com/kbrashears5/typescript-aws-apigateway-helper

apigateway aws helper javascript lambda typescript

Last synced: 2 months ago
JSON representation

Typescript AWS API Gateway Helper

• Host: GitHub
• URL: https://github.com/kbrashears5/typescript-aws-apigateway-helper
• Owner: kbrashears5
• License: mit
• Created: 2020-05-28T01:42:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-01T16:40:32.000Z (7 months ago)
• Last Synced: 2024-10-07T22:37:59.296Z (3 months ago)
• Topics: apigateway, aws, helper, javascript, lambda, typescript
• Language: TypeScript
• Homepage: https://github.com/kbrashears5/typescript-aws-apigateway-helper#readme
• Size: 78.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
typescript-aws-apigateway-helper




    

Typescript helper functions for AWS API Gateway

    

[![CI/CD](https://github.com/kbrashears5/typescript-aws-apigateway-helper/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/kbrashears5/typescript-aws-apigateway-helper/actions/workflows/ci-cd.yml)

[![codecov](https://codecov.io/gh/kbrashears5/typescript-aws-apigateway-helper/branch/master/graph/badge.svg?token=N94B7YD0N4)](https://codecov.io/gh/kbrashears5/typescript-aws-apigateway-helper)

[![NPM Version](https://img.shields.io/npm/v/typescript-aws-apigateway-helper)](https://img.shields.io/npm/v/typescript-aws-apigateway-helper)

[![Downloads](https://img.shields.io/npm/dt/typescript-aws-apigateway-helper)](https://img.shields.io/npm/dt/typescript-aws-apigateway-helper)




## Install

```

npm install typescript-aws-apigateway-helper@latest

```

## Usage

### Default - running in Lambda in your own account

```typescript

const logger = new Logger(LogLevel.Trace);

const helper = new APIGatewayHelper(logger);

const response = await helper.CreateApiKeyAsync(

  'apiKey',

  'description',

  'value',

);

```

### Running in separate account or not in Lambda

```typescript

import * as APIGateway from '@aws-sdk/client-api-gateway';

const logger = new Logger(LogLevel.Trace);

const options: APIGateway.APIGatewayClientConfig = {

  accessKeyId: '{access_key}',

  secretAccessKey: '{secret_key}',

  region: 'us-east-1',

};

const repository = new APIGateway.APIGateway(options);

const helper = new APIGatewayHelper(logger, repository);

const response = await helper.CreateApiKeyAsync(

  'apiKey',

  'description',

  'value',

);

```

## Notes

If no options are supplied, will default to `us-east-1` as the region

## Development

Clone the latest and run

```npm

npm run prep

```

to install packages and prep the git hooks