Categorygithub.com/UPB-Code-Labs/main-api
module
0.53.5
Repository: https://github.com/upb-code-labs/main-api.git
Documentation: pkg.go.dev

# 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:

DocumentDescription
ContributingContributing guidelines.
EnvironmentA description of the environment variables used by the gateway service.
Bruno CollectionA collection of REST API requests to be used with Bruno.
Insomnia CollectionA collection of REST API requests to be used with Insomnia.
OpenAPI SpecificationA description of the REST API using the OpenAPI Specification.

# Packages

No description provided by the author