Skip to content

Esh07/Module-Timetable-Management-System-RESTful-API

Repository files navigation

Module Timetable Management System - RESTful API cover image

🗓️ Module Timetable REST API

A Spring Boot REST API for managing university module timetables, convenors, and teaching sessions

Java Spring Boot MySQL Gradle Swagger


🧭 Overview

A RESTful API built with Java and Spring Boot for managing the full lifecycle of university module timetabling — including convenors, modules, and individual teaching sessions.

Designed around clean REST principles, with input validation, structured error responses, and Swagger/OpenAPI documentation.

✨ Features

Resource Operations
👨‍🏫 Convenors Create, read, update, delete convenor records
📚 Modules Manage module metadata, assign/update convenors
🕐 Sessions Create and manage teaching sessions per module
✅ Validation Structured error responses for invalid or missing input
📖 Docs Interactive Swagger UI at /swagger-ui.html

🛠 Tech Stack

  • Language: Java 11
  • Framework: Spring Framework, Spring Data JPA, Spring MVC
  • Database: MySQL 8.x
  • ORM: Hibernate via Spring Data JPA
  • Build Tool: Gradle 6.0+
  • Docs: Swagger / OpenAPI ORM
  • API Testing: Postman
  • Version Control: Git

⚙️ Getting Started

To get started with the project, please refer to the installation guide.

API Documentation

The API documentation provides detailed information about the available endpoints, request/response schemas, and examples. Please refer to the API Documentation for more details.

📋 Project Status

Coursework Archive Demonstrates Spring Boot REST API design, Spring Data JPA, MySQL integration, validation, Gradle builds, and Swagger documentation.

License

Licensed under the MIT License.

About

Spring Boot REST API for managing module timetables, convenors, modules, and teaching sessions with MySQL, Gradle, and Swagger/OpenAPI documentation with Postman collection included.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages