Repository files navigation

A library and standalone service that composes your GraphQL APIs into one endpoint.

For a guide to getting started readthis post. For full documentation visit thegateway homepage.

The simplest way to run a gateway is to download an executable for your operating systemfrom thelatest release on GitHub and then run it directly on your machine:

$ ./gateway start --port 4000 --services http://localhost:3000,http://localhost:3001

Note: Instead of./gateway, use the file path to the release you downloaded.macOS users should use thedarwin release file.

For more information on possible arguments to pass the executable, run./gateway --help.

Alternatively, install it with thego command to your Go bin and run it:

$ go install github.com/nautilus/gateway/cmd/gateway@latest$ gateway start --port 4000 --services http://localhost:3000,http://localhost:3001

This will start a server on port 4000 that wraps over the servicesrunning athttp://localhost:3000 andhttp://localhost:3001.

For more information on possible arguments to pass the executable, rungateway --help.

This project is built as a go module and follows the practices outlined in thespec. Please consider all APIs experimental and subjectto change until v1 has been released at which point semantic versioning will be strictly followed. Beforethen, minor version bumps denote an API breaking change.

Currently supports Go Modules using Go 1.16 and above.