A simple lightweight API gateway that will run in a docker container, authenticate using a JWT strategy and then conditionally auto-generate routes from config or proxy all req.url strings to the specified proxy URL. Great for micro-service architecture and abstracting your security layer away from your primary app if required.
You'll need docker if you don't already ahve it installed. Containerize all the things!
Adjust the ENV vars in .env.development to your liking and adjust config.js to include setting your hostUrl then:
# clone it
git clone git@github.com:ezy/express-api-gateway.git
cd express-api-gateway
# Build and start your server
docker-compose up --build
API will be available at localhost:<PORT> for http requests.
Specify your endpoints in config.js under the routes object using the correct request method object (get,post,put,delete). Routes will be generated at runtime from this list using the following configuration:
- host: { string } over-rides
hostUrlto specify proxy target host, - path: { string } the target path for the req and res,
- auth: { boolean } set to true to require JWT authentication for the endpoint
Set proxyAll: true in config to proxy all requests to config.hostUrl. The Authentication Bearer header JWT is turned on by default for proxyAll.
/*: (JWT secure) wildcard proxy sends url.req to specifiedconfig.hostUrl.
A basic JWT token endpoint is available unconfigured at:
/oauth/tokenPOST: uses req.body{ "userId": "ezy", "password": "Secure" }to return a valid JWT token
App is configured for both http and https and runs http out of the box. To enable https generate (or provide) your https certs - privateKey.pem, certificate.pem, authority.pem (optional) - in the root directory, and set config.protocol: 'https'.
Import the postman file located at ./scalpelway.postman_collection.json to test the endpoints.
MIT