SpringBootLibrary Documentation

Welcome to the SpringBootLibrary technical documentation portal. This site aggregates all documentation artifacts generated for the project, including architectural guides, Javadoc API reference, test reports, and code quality reports.

📖 Project Overview

• Project Overview
  • Purpose
  • Key Features
  • Live Documentation Links
  • Repository Structure
• Architecture
  • MVC Pattern
  • Package Structure
  • Key Design Decisions
  • Static Resources
• Getting Started
  • Prerequisites
  • Database Setup
  • Running the Application
  • Running with Docker
  • Quick Reference: Maven Commands

🧪 Testing & Quality

• Testing Strategy
  • Unit Tests
  • Integration Tests
  • Performance Tests
  • Code Coverage
  • Static Analysis
• Test & Quality Reports
  • Javadoc API Reference
  • JaCoCo — Code Coverage
  • Surefire — Unit Test Report
  • Performance Tests
  • Checkstyle
  • PMD — Static Analysis
  • JDepend — Package Metrics
  • Doxygen
  • Complete path map
  • Generating All Reports Locally

🔌 API Reference

• REST API Reference
  • Swagger UI (Live)
  • Endpoints Summary
  • Request / Response Examples
• Javadoc API Documentation
  • Why Javadoc was missing — and the fix
  • Key Documented Classes
  • Generating Javadoc Locally
  • Javadoc vs Doxygen

🚀 DevOps & CI/CD

• CI/CD with GitHub Actions
  • Workflow 1: maven-site-integration.yml
  • Workflow 2: sphinx-docs.yml
  • GitHub Pages Setup
  • Triggering Workflows via API
• Docker & Docker Compose
  • Quick Start
  • Dockerfile
  • docker-compose.yml
  • VisualVM Profiling

📚 External Tools

• Sphinx 101 — Complete Guide

Indices and tables

• Index

• Search Page