API Documentation

This document provides an overview of the Motlobo Online Home School API endpoints.

Base URL

https://api.motlobo.ac.bw

Endpoints

GET /

Returns a success message indicating that the API is working as expected.

Response

{
    "success": true,
    "message": "The API is working as expected."
}
    

404 Not Found

This is a fallback route that is triggered when an undefined endpoint is accessed.

Response

{
    "message": "The endpoint you specified was not found.",
    "success": false
}
    

Middleware

The following middleware is applied globally:

• cors: Allows cross-origin requests from any origin.
• body-parser: Parses incoming request bodies with a limit of 100MB.

Imported Routes

The authentication module is imported and initialized. Refer to the ./src/routes/authentication file for more details on the routes it defines.