Skip to content

The central API to handle most of the CRUD operations 📊

License

Notifications You must be signed in to change notification settings

upb-code-labs/main-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.