https://github.com/rodolfoaugusto/coder-api
AWS CDK - REST API
https://github.com/rodolfoaugusto/coder-api
aws aws-cdk dynamodb lambda
Last synced: 10 months ago
JSON representation
AWS CDK - REST API
- Host: GitHub
- URL: https://github.com/rodolfoaugusto/coder-api
- Owner: rodolfoaugusto
- Created: 2022-09-01T13:49:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T18:04:57.000Z (about 3 years ago)
- Last Synced: 2025-01-02T10:45:36.678Z (12 months ago)
- Topics: aws, aws-cdk, dynamodb, lambda
- Language: TypeScript
- Homepage:
- Size: 72.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coder API
The Coder API is a centralized API to connect multiple tools for open-source projects using public API's.
# API Tools
- Postal Codes (Brazil)
### API Structure (Postal Code Service)
| HTTP METHOD | POST | GET | PUT | DELETE |
| ----------- | ----------------- | -------------------------- | ----------------- | ----------- |
| CRUD OP | CREATE | READ | UPDATE | DELETE |
| /postalcode/:country/:value | Ok (200) | Error (404) | Error (404) | Error (404) |
## Infrastructure Architecture
The infrastructure overview can be found at
* [Architecture](https://app.diagrams.net/?splash=0&libs=aws4#G15-NriNevQ1Ynqq3z40MbPPlnfHQBlt4I)
## AWS Resources Deployed
* AWS Route53 Hosted Zone
* AWS API Gateway
* AWS DynamoDB
## Getting Started
### Requirements
* NodeJS (13/14 recommended)
* NPM
* [AWS CDK](https://docs.aws.amazon.com/cdk/latest/guide/home.html)
### Development
```
git clone git@github.com:rodolfoaugusto/coder-api.git
cd coder-api
npm run build
npm run test
npm run deploy
```
* You have to assume to appropriate AWS IAM Role by using the awscli before tryng to deploy the resources defined by the Stack.