eagletrt-api/api-gateway

The API Gateway is responsible for request routing, composition, and protocol translation. All requests from clients first go through the API Gateway. It then routes requests to the appropriate microservice. The API Gateway will often handle a request by invoking multiple microservices and aggregating the results.

GETstatus

http://localhost:3000/status

Return the status of the service

Example Request

curl

curl --location 'http://localhost:3000/status'

200 OK

Example Response

json

{
  "status": "OK"
}

X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

ETag

W/"f-v/Y1JusChTxrQUzPtNAKycooOTA"

Date

Wed, 31 Mar 2021 17:26:12 GMT

Connection

keep-alive

Keep-Alive

timeout=5

GETdocs api

http://localhost:3000/api-docs/

Example Request

curl

curl --location 'http://localhost:3000/api-docs/'

200 OK

Example Response

html


<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Swagger UI</title>
        <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
        <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
        <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
        <style>
    html
    {
      box-sizing: border-box;
      overflow: -moz-scrollbars-vertical;
      overflow-y: scroll;
    }
    *,
    *:before,
    *:after
    {
      box-sizing: inherit;
    }

    body {
      margin:0;
      background: #fafafa;
    }
  </style>
    </head>
    <body>
        <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
            <defs>
                <symbol viewBox="0 0 20 20" id="unlocked">
                    <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
                </symbol>
                <symbol viewBox="0 0 20 20" id="locked">
                    <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
                </symbol>
                <symbol viewBox="0 0 20 20" id="close">
                    <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
                </symbol>
                <symbol viewBox="0 0 20 20" id="large-arrow">
                    <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
                </symbol>
                <symbol viewBox="0 0 20 20" id="large-arrow-down">
                    <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
                </symbol>
                <symbol viewBox="0 0 24 24" id="jump-to">
                    <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
                </symbol>
                <symbol viewBox="0 0 24 24" id="expand">
                    <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
                </symbol>
            </defs>
        </svg>
        <div id="swagger-ui"></div>
        <script src="./swagger-ui-bundle.js"> </script>
        <script src="./swagger-ui-standalone-preset.js"> </script>
        <script src="./swagger-ui-init.js"> </script>
        <style>
  .swagger-ui .topbar .download-url-wrapper { display: none } undefined
</style>
    </body>
</html>

X-Powered-By

Express

Access-Control-Allow-Origin

Content-Type

text/html; charset=utf-8

Content-Length

3104

ETag

W/"c20-YaHADSLwvE3kEdwr5u3Bfu2fhF8"

Date

Wed, 31 Mar 2021 17:26:22 GMT

Connection

keep-alive

Keep-Alive

timeout=5

GETdocumentation/:microservice

http://localhost:3000/api/v1/documentation/:microservice

AUTHORIZATIONBearer Token

Token

<token>

PATH VARIABLES

microservice

users

Example Request

curl

curl --location 'http://localhost:3000/api/v1/documentation/users'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTlogin

http://localhost:3000/api/v1/login

Bodyraw (json)

json

{
    "username": "12bolliccissas",
    "password": "123trueORfalseOrNegative"
}

Example Request

curl

curl --location 'http://localhost:3000/api/v1/login' \
--data '{
    "username": "12bolliccissas",
    "password": "123trueORfalseOrNegative"
}'

200 OK

Example Response

json

{
  "username": "12bolliccissas",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IjEyYm9sbGljY2lzc2FzIiwicGFzc3dvcmQiOiIxMjN0cnVlT1JmYWxzZU9yTmVnYXRpdmUiLCJpYXQiOjE2MTcyMTM4Mzh9.Ofty0ANe68t2UR8gzzIvBT0lM22ZL-a8RIpkaLg9nX8"
}

X-Powered-By

Express

Access-Control-Allow-Origin

Authentication

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IjEyYm9sbGljY2lzc2FzIiwicGFzc3dvcmQiOiIxMjN0cnVlT1JmYWxzZU9yTmVnYXRpdmUiLCJpYXQiOjE2MTcyMTM4Mzh9.Ofty0ANe68t2UR8gzzIvBT0lM22ZL-a8RIpkaLg9nX8

Content-Type

application/json; charset=utf-8

Content-Length

233

ETag

W/"e9-mNFhLiqZKY4UqqeUhPhu6TPTxR4"

Date

Wed, 31 Mar 2021 18:03:58 GMT

Connection

keep-alive

Keep-Alive

timeout=5

POSTsignup

http://localhost:3000/api/v1/signup

Bodyraw (json)

json

{
    "name": "Bart",
    "surname": "Simpson",
    "username": "Bartolomeo",
    "password": "eagleTRT"
}

Example Request

curl

curl --location 'http://localhost:3000/api/v1/signup' \
--data '{
    "name": "Thomas",
    "surname": "Turbato",
    "username": "eagleTRT",
    "password": "eagleTRT"
}'

200 OK

Example Response

json

{
  "username": "eagleTRT",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVhZ2xlVFJUIiwicGFzc3dvcmQiOiJlYWdsZVRSVCIsImlhdCI6MTYxNzIxMzg1OX0.fpYuQRbVlS__nRp_dRf64KBS9n-l83xOg7b3RI-jMDU"
}

X-Powered-By

Express

Access-Control-Allow-Origin

Authentication

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVhZ2xlVFJUIiwicGFzc3dvcmQiOiJlYWdsZVRSVCIsImlhdCI6MTYxNzIxMzg1OX0.fpYuQRbVlS__nRp_dRf64KBS9n-l83xOg7b3RI-jMDU

Content-Type

application/json; charset=utf-8

Content-Length

198

ETag

W/"c6-lJXAoSHUyc2kaJZNb7gLLFdTAmI"

Date

Wed, 31 Mar 2021 18:04:20 GMT

Connection

keep-alive

Keep-Alive

timeout=5