API Gateway is a scalable, open source API Layer (also known as a API Middleware). API Gateway runs in front of any RESTful API and provide functionalities and services such as requests routing, authentication, rate limiting, etc.
API Dashboard is a UI tool that will let you manage your API Gateway setup, a portuguese version based on PGBI/kong-dashboard@v2.
API Gateway Version >= 0.10.x
Click thumbnails to enlarge.
You will need:
- a running API Gateway.
- nodejs and npm.
# Install API Dashboard
npm install -g api-dashboard
# Start API Dashboard
api-dashboard start
# To start API Dashboard on a custom port
api-dashboard start -p [port]
# To start API Dashboard with basic auth
api-dashboard start -a user=password
# You can set basic auth user with environment variables
# Do not set -a parameter or this will be overwritten
set api-dashboard-name=admin && set api-dashboard-pass=password && api-dashboard start
# Pull repository
git clone https://github.com/EnergisaOne/api-dashboard.git
cd api-dashboard
git checkout 1.0
# Build API Dashboard
npm install
npm run build
# Start API Dashboard
npm start
# To start API Dashboard on a custom port or with basic auth
npm start -- [-p port] [-a user=password]
# Start API Dashboard
docker run -d -p 8080:8080 energisaone/api-dashboard
# Start API Dashboard on a custom port
docker run -d -p [port]:8080 energisaone/api-dashboard
# Start API Dashboard with basic auth
docker run -d -p 8080:8080 energisaone/api-dashboard -a user=password
# Pull repository
git clone https://github.com/energisaone/api-dashboard.git
cd api-dashboard
git checkout 1.0
# Start VM
vagrant up
When browsing API-Dashboard, you will be asked to provide the URL of your API node.
If you're hosting the Gateway on your local machine, the "node URL" is not "http://localhost:8001". It will be your machine/LAN IP, for example: "http://192.168.x.x:8001"
You can now browse your API Dashboard at http://localhost:8080