Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/whitiue/logiMathApp/llms.txt

Use this file to discover all available pages before exploring further.

The LogiMath backend is a FastAPI application served at http://localhost:8000. It exposes endpoints for managing users and quiz questions, and automatically generates interactive API documentation via Swagger UI and ReDoc. The server accepts requests from any origin and is designed to run alongside the LogiMath frontend during local development.

​
Base URL

http://localhost:8000

​
Health check

Send a GET request to / to verify the server is running. 
curl http://localhost:8000/

{"message": "LogiMath API running! 🚀"}
The health check route also accepts HEAD requests, which is useful for uptime monitors that prefer not to download a response body.

​
Interactive documentation

FastAPI generates two interactive documentation UIs automatically:
InterfaceURL
Swagger UIhttp://localhost:8000/docs
ReDochttp://localhost:8000/redoc
Both UIs reflect the live API and allow you to execute requests directly from the browser without any additional tooling.

​
CORS policy

The server is configured with allow_origins=["*"], which means requests from any origin are accepted. This is intentional for local development but should be restricted to known origins before deploying to a production environment.
allow_origins=["*"] with allow_credentials=True can cause browsers to reject requests. Restrict origins to specific domains before deploying to production.

​
Endpoint groups

Users

Create and retrieve user accounts. Returns id, name, and email — password hash is never exposed.

Quizzes

Quiz data model reference and notes on the current implementation status of quiz list endpoints.

Questions

List and create questions scoped to a specific quiz by quiz ID.

Build docs developers (and LLMs) love

Get started for freeTalk to us