Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.58 KB

File metadata and controls

61 lines (39 loc) · 2.58 KB

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.