main-api

module
v0.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2024 License: AGPL-3.0

README

Gateway

Welcome to the gateway repository. This service is responsible for the following tasks:

  • Authentication
  • Authorization
  • Serve the REST API
  • Send SSE updates to the web client
  • Proxy requests to the static files micro-service
  • Publish messages to the RabbitMQ submissions queue

Bellow is a diagram of the overall architecture of the system with the gateway / main api highlighted in green.

Gateway service highlighted with a green rectangle in the overall architecture diagram

Documentation

Please, refer to the following documents for more information about the gateway service:

Document Description
Contributing Contributing guidelines.
Environment A description of the environment variables used by the gateway service.
Bruno Collection A collection of REST API requests to be used with Bruno.
Insomnia Collection A collection of REST API requests to be used with Insomnia.
OpenAPI Specification A description of the REST API using the OpenAPI Specification.

Directories

Path Synopsis
src

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL