api-gatekeeper

README

API Gatekeeper

A simple API and user management gateway.

flowchart LR
    subgraph Public Network
    REQ[/Web Requests/]
    end
    subgraph Private Network
    API[API Gatekeeper]
    BACK1[[Backend 1]]
    BACK2[[Backend 2]]
    BACK3[[Backend 3]]
    end

    REQ --request to route on [Backend 1]--> API
    API --request data---> BACK1
    BACK1 --response---> API
    API--[Backend 1] response-->REQ
    API ---> BACK2
    API ---> BACK3

Use Cases

The API Gatekeeper is a application that sits between the public web requests and your backends (monoliths, microsservices, etc.). It focus on the following use cases:

• API Gateway: api-gatekeeper allows you to expose multiple HTTP backends on the same host using the included auth.
• User Management: api-gatekeeper comes with a full featured user resource system, with scope based authentication and authorization.

Requirements

1. Any operating system that can run the released binaries
2. A compatible database. Supported databases:
   • PostgreSQL, version 12+

Usage

1. Download the latest application binary from the Releases page
2. Create a configuration file. There is a example on examples/config.yaml
3. Start the application using the configuration file with the command:

   ./api-gatekeeper-linux-amd64 -config=$HOME/config.yaml
   

Configuration

The configuration is done by a yaml file. This file path must be provided by the -config=<path to yaml> when running the application. The configuration properties are:

api:                        # The application api configuration
  address: "localhost:3000" # The application listen address
  user:                     # The application user, it will be persisted on the application startup
    login: admin            # The application user login, in a production environment this must be secured
    password: admin         # The application user password, in a production environment this must be secured

database:                                                                                        # The application database configurations
  provider: "postgres"                                                                           # The database provider
  dsn: "postgresql://api-gatekeeper:api-gatekeeper@postgres:5432/api-gatekeeper?sslmode=disable" # The database connection dsn

backends:                         # The backends configurations
  - name: "ping-backend"          # The backend name
    host: "http://localhost:8080" # The backend host
    scopes:                       # (Optional) The authentication scopes required for every route in this backend
      - "ping-backend-scope"
    headers: # (Optional) The headers to be included in the request for every route in this backend
      Authorization: "Bearer foobar"
      X-Example-Header-backend: "example backend header"
    routes:                     # The backend routes
      - method: "GET"           # The route method
        backendPath: "/ping"    # The absolute path on your application, path variables are replicated as long as both have the same name
        gatekeeperPath: "/ping" # The absolute path that will be exposed by the api-gatekeeper, path variables are replicated as long as both have the same name
        timeoutSeconds: 30      # (Optional) The timeout in seconds, set to 0 to dont timeout
        isPublic: false         # (Optional) If this route is public
        scopes:                 # (Optional) The authentication scopes required for this route, they will be added with the backend scopes
          - "ping-backend.get-ping-scope"
        headers: # (Optional) The headers to be included in the request for this route
          X-Example-Header-Route: "example route header"

User Management

Alongside the API Gateway capabilities this application is also powered with a simple user management system.

This is done using the integrated REST API, the example requests can be found on the requests.http file on this repository root;

FAQ

Is this application production ready?

In the moment No.