Spring Boot REST API

Enterprise-grade REST API with Spring Boot framework. Features JWT authentication, database integration, caching, and comprehensive API documentation.

View on GitHub Get Started
Java 17 Spring Boot 3.2.0 JWT PostgreSQL Redis
81+
Total Files
15+
API Endpoints
11
Documentation Files
26
Java Classes

Key Features

JWT Authentication

Token-based authentication with refresh tokens, role-based access control, and secure password encryption.

Database Integration

PostgreSQL for production, H2 for development, JPA/Hibernate ORM, and automatic schema management.

Redis Caching

High-performance caching with Redis, distributed cache support, and configurable TTL settings.

Installation Guide

Prerequisites

Java 17 or higher

Ensure you have Java Development Kit (JDK) 17 or later installed.

java -version
Maven 3.6 or higher

Apache Maven for building and managing the project.

mvn -version

Installation Steps

Step 1: Clone the Repository
git clone https://github.com/rskworld/spring-boot-api.git
cd spring-boot-api
Step 2: Build the Application
mvn clean package
Step 3: Run the Application
java -jar target/spring-boot-api-1.0.0.jar
Step 4: Access the API

Open your browser and navigate to:

http://localhost:8080
Quick Start
Docker Setup (Recommended)
docker-compose up -d
Development Mode
mvn spring-boot:run
Test the API
curl http://localhost:8080/health

Project Structure & Files

Root Directory

📄 pom.xml - Maven configuration (4.7KB)
📄 README.md - Project overview (8.5KB)
📄 API_DOCUMENTATION.md - API reference (8.3KB)
📄 DEPLOYMENT.md - Deployment guide (12.7KB)
📄 SECURITY.md - Security guide (6.8KB)
🐳 Dockerfile - Container configuration (1.4KB)
🐳 docker-compose.yml - Development environment (2.5KB)

Source Code Structure

📁 src/main/java/com/rskworld/
☕ SpringBootApiApplication.java - Main class (1.4KB)
📁 config/ - Configuration classes
📁 controller/ - REST controllers
📁 entity/ - JPA entities
📁 repository/ - Data repositories
📁 service/ - Business logic
📁 security/ - Security components
📁 dto/ - Data Transfer Objects
📁 exception/ - Exception handling

Documentation & Resources

API Documentation

Complete API reference with all endpoints, authentication, and examples.

View Documentation
Deployment Guide

Step-by-step deployment instructions for various environments.

View Guide

Contact RSK World

Get in Touch

Email: help@rskworld.in, support@rskworld.in

Phone: +91 93305 39277

Website: https://rskworld.in

Address: Nutanhat, Mongolkote, Purba Burdwan, West Bengal, India, 713147