Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omerap12/serverless-url-shortener-api
This repository contains Terraform configurations and AWS Lambda functions to create a simple URL shortener API using AWS API Gateway, AWS Lambda, and DynamoDB.
https://github.com/omerap12/serverless-url-shortener-api
aws terraform
Last synced: 2 months ago
JSON representation
This repository contains Terraform configurations and AWS Lambda functions to create a simple URL shortener API using AWS API Gateway, AWS Lambda, and DynamoDB.
- Host: GitHub
- URL: https://github.com/omerap12/serverless-url-shortener-api
- Owner: omerap12
- Created: 2023-03-13T12:20:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-11T12:07:28.000Z (about 1 year ago)
- Last Synced: 2024-10-08T12:58:40.649Z (3 months ago)
- Topics: aws, terraform
- Language: HCL
- Homepage:
- Size: 476 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless URL Shortener API
This repository contains Terraform configurations and AWS Lambda functions to create a simple URL shortener API using AWS API Gateway, AWS Lambda, and DynamoDB. The API allows users to create short URLs and retrieve the original full URLs associated with the short URLs.
## Terraform Configurations
The Terraform configurations in this repository create the following AWS resources:
* API Gateway: An API Gateway with HTTP protocol enabled. It has two routes:
1. GET /read: Retrieves the original full URL associated with a short URL.
2. POST /write: Creates a short URL associated with a full URL.
* AWS Lambda Functions:
1. read_lambda: Handles the GET /read route. It retrieves the full URL associated with a short URL from DynamoDB.
2. write_lambda: Handles the POST /write route. It stores the short URL and full
* URL mapping in DynamoDB.
DynamoDB Table: A DynamoDB table named url-table to store the mappings between short URLs and full URLs.
## Prerequisites
Before applying the Terraform configurations, make sure you have the following:
* AWS account credentials configured.
* Terraform installed on your local machine.
## Deployment
1. Clone this repository:
```bash
git clone https://github.com/omerap12/Serverless-url-shortener-api.git
cd Serverless-url-shortener-api
```
2. Initialize Terraform and apply the configurations:
```bash
terraform init
terraform apply
```
3. After applying the Terraform configurations, the API Gateway endpoint URLs for read and write operations will be provided as outputs. You can find them in the Terraform output variables.
## Usage Examples
### Add Short URL
To add a short URL, use the following `curl` command:
```bash
curl -X POST -d '{"full_url":"test.com","short_url":"test"}' -H "Content-Type: application/json" -i $api_url_write
```
### Get Full URL
To get a Full URL from a short URL, use the following `curl` command:
```bash
curl -X GET -d '{"short_url":"test"}' -H "Content-Type: application/json" -i $api_url_read
```
## Lambda Functions
### `read_lambda` Function
The read_lambda function handles the GET /read route. It takes a short URL as input, retrieves the corresponding full URL from DynamoDB, and returns the full URL in the response.
### `write_lambda` Function
The write_lambda function handles the POST /write route. It takes a JSON payload containing a short URL and a full URL, stores the mapping in DynamoDB, and returns a success message in the response.
## Cleanup
To destroy the resources created by Terraform, run:
```bash
terraform destroy
```