https://github.com/ayltai/passthrough-proxy-weatherbit
A pass-through proxy to communicate with Weatherbit API server
https://github.com/ayltai/passthrough-proxy-weatherbit
aws aws-lambda terraform weather weather-api weatherbit weatherbit-api
Last synced: about 2 months ago
JSON representation
A pass-through proxy to communicate with Weatherbit API server
- Host: GitHub
- URL: https://github.com/ayltai/passthrough-proxy-weatherbit
- Owner: ayltai
- License: mit
- Created: 2021-08-18T08:43:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-28T14:04:12.000Z (almost 5 years ago)
- Last Synced: 2025-10-30T03:49:10.671Z (8 months ago)
- Topics: aws, aws-lambda, terraform, weather, weather-api, weatherbit, weatherbit-api
- Language: HCL
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Weatherbit API pass-through proxy server
[](https://github.com/ayltai/passthrough-proxy-weatherbit/actions)
[](https://github.com/ayltai/passthrough-proxy-weatherbit/releases)
[](https://github.com/ayltai/passthrough-proxy-weatherbit/blob/master/LICENSE)
A pass-through proxy to communicate with [Weatherbit](https://www.weatherbit.io) API server.
## How it works
It acts as a simple web proxy that sends all requests it receives to `https://api.weatherbit.io`. You may need to send your secret key to the proxy if it is a protected API. Check the official [documentation](https://www.weatherbit.io/api).
The proxy runs on AWS Lambda.
## Supported APIs
* `/v2.0/current`
* `/v2.0/forecast/hourly`
* `/v2.0/forecast/daily`
## Setup
[Terraform](https://www.terraform.io) is used for deployment on AWS.
### Development
[LocalStack](https://localstack.cloud) is used to provide local AWS services.
**Requirements**
* [Docker](https://www.docker.com)
**Steps**
1. Start LocalStack
```shell
docker run --rm -it -p 4566:4566 -p 4571:4571 -e "SERVICES=iam,lambda,apigateway,cloudwatch,logs,sts" localstack/localstack
```
2. Run Terraform scripts
```shell
cd terraform/local
terraform init
terraform apply -auto-approve
```
3. Take note of the outputs when Terraform completes. Example:
```shell
Outputs:
rest_api_url = "http://localhost:4566/restapis/7rujauhl95/api/_user_request_"
```
4. Test the deployed endpoint
```shell
curl http://localhost:4566/restapis/7rujauhl95/api/_user_request_/v2.0/current?key=[API Key]&lat=22.3193&lon=114.1694&lang=en
```
### Production
**Requirements**
* Have an AWS account ready. We will need the Access and Secret Keys to run the Terraform scripts.
* Have a Terraform account ready. We will need it to store the Terraform states.
**Steps**
1. Run Terraform scripts
```shell
cd terraform/remote
terraform init
terraform apply -auto-approve
```
2. Take note of the outputs when Terraform completes
3. Test the deployed endpoint