dgate

README

DGate - Distributed API Gateway

DGate is a distributed API Gateway built for developers. DGate allows you to use JavaScript/TypeScript to modify request/response data(L7). Inspired by k6 and kong.

DGate is currently in development and is not ready for production use. Please use at your own discretion.

Getting Started

http://dgate.io/docs/getting-started

Installing

# requires go 1.22+
go install github.com/dgate-io/dgate/cmd/dgate-server@latest

Application Architecture

DGate Server (dgate-server)

DGate Server is proxy and admin server bundled into one. the admin server is responsible for managing the state of the proxy server. The proxy server is responsible for routing requests to upstream servers. The admin server can also be used to manage the state of the cluster using the Raft Consensus Algorithm.

DGate CLI (dgate-cli)

DGate CLI is a command-line interface that can be used to interact with the DGate Server. It can be used to deploy modules, manage the state of the cluster, and more.

Proxy Modules

• Fetch Upstream Module (fetchUpstream) - executed before the request is sent to the upstream server. This module is used to decided which upstream server to send the current request to. (Essentially a custom load balancer module)

• Request Modifier Module (requestModifier) - executed before the request is sent to the upstream server. This module is used to modify the request before it is sent to the upstream server.

• Response Modifier Module (responseModifier) - executed after the response is received from the upstream server. This module is used to modify the response before it is sent to the client.

• Error Handler Module (errorHandler) - executed when an error occurs when sending a request to the upstream server. This module is used to modify the response before it is sent to the client.

• Request Handler Module (requestHandler) - executed when a request is received from the client. This module is used to handle arbitrary requests, instead of using an upstream service.