https://github.com/adebsalert/api-gateway
Typescript API Gateway
https://github.com/adebsalert/api-gateway
api-gateway gateway microservice rest-api typescript
Last synced: 11 months ago
JSON representation
Typescript API Gateway
- Host: GitHub
- URL: https://github.com/adebsalert/api-gateway
- Owner: AdebsAlert
- Created: 2021-12-31T14:37:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-14T17:37:35.000Z (about 4 years ago)
- Last Synced: 2025-03-30T16:39:07.414Z (12 months ago)
- Topics: api-gateway, gateway, microservice, rest-api, typescript
- Language: TypeScript
- Homepage:
- Size: 229 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API-Gateway
A simple but robust API Gateway written in [TypeScript](https://www.typescriptlang.org/).
API Gateway is a developer friendly tool that sits at the heart of your microservices architecture and securely expose them through APIs using Nodejs.
## Features
- `Authentication` (Auth0)
- `Service Registry`
- `Service Management`
- `Load Balancing`
- `API Health & PING`
- `REST API`
- `Logging`
## Installation
1. Clone the repository to your project root directory using this command: (replace `api-gateway` with a folder name for the gateway)
```sh
git clone https://github.com/AdebsAlert/api-gateway.git api-gateway
```
2. CD into the gateway directory and install all dependencies:
```sh
cd api-gateway
npm install -g typescript
npm install
```
3. Create a .env file from the .env.example file and enter your key values
```sh
cp .env.example .env
```
4. Set your AUTH policy in your .env file and your policy params
```sh
AUTH_POLICY='auth0' or 'custom'
```
5. Build and start the API Gateway
```sh
npm run build-ts
npm run watch-serve
```
## Service Management
https://documenter.getpostman.com/view/4644005/UVkvKYZS
## License
[MIT](LICENSE)