Introduction

The API aims to provide a foundation for the different parts of the Jonas_Jones Ecosystem to interact with each other.

Composition

The APi features 2 parts, the front-end and the back-end

Front-End

A cloudflare worker available on Github that routes the traffic to the back-end and has a route for the API's uptime status:

• GET /status - Get API uptime status

Response

200

API is up and running
{
    "status": 200,
    "statusText": "Ok"
}

503

API is down
{
    "status": 503,
    "statusText": "Service Unavailable"
}

Back-End

info

The Back-End is only available when the /status route returns code 200

In theory this should always be the case but it is not guaranteed. Downtime can occur from time to time.

A Rust back-end available on Github that handles all the forwarded requests from the front-end. The API is currently in it's first version therefore all routes start with /v1/. The routes are referenced on the v1 Routes page.