Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/miagv/PlataformaEduca/llms.txt

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

PlataformaEduca is a backend REST API built with Spring Boot and Java 21 that provides everything needed to manage an educational institution. It handles multi-role user registration and JWT authentication, a full course catalog, teacher scheduling across classrooms and academic periods, and a two-level grade management system for evaluations and student scores.

Quickstart

Get the API running locally and make your first authenticated request in minutes.

Authentication

Learn how to register, log in, and include JWT tokens in your API requests.

API Reference

Explore every endpoint — request bodies, response shapes, and error codes.

Role Guides

Step-by-step workflows for coordinators, teachers, and students.

What PlataformaEduca provides

PlataformaEduca exposes a stateless JSON REST API secured with JWT tokens. Every user is assigned one of three primary roles — Coordinator, Teacher (Docente), or Student (Estudiante) — and the API enforces role-based access on every protected route.

Multi-role auth

JWT-secured login with automatic profile creation per role on registration.

Course management

Full CRUD for courses — create, list, update, and delete course records.

Teacher scheduling

Assign teachers to courses, classrooms, and academic periods through a single scheduling entity.

Grade tracking

Two-level model: weighted evaluations plus individual student scores per evaluation.

Coordinator dashboard

Platform-wide statistics covering users, courses, grades, and assignments.

OpenAPI docs

Interactive Swagger UI available at /swagger-ui.html on any running instance.

How the roles work

RoleKey capabilities
CoordinatorView platform stats, manage teacher assignments, list grades and classrooms
Teacher (Docente)View assigned courses, create evaluations, record student grades
Student (Estudiante)View enrolled courses, access personal grade report
All endpoints except /api/auth/register and /api/auth/login require a valid JWT token in the Authorization: Bearer <token> header.

Next steps

1

Run the API locally

Follow the Quickstart to clone the repo, configure MySQL, and boot the server.
2

Authenticate

Register a user and obtain a JWT token as described in the Authentication guide.
3

Explore by role

Choose the guide that matches your use case: Coordinator, Teacher, or Student.
4

Browse the API reference

See every endpoint with full request/response schemas in the API Reference.

Build docs developers (and LLMs) love