mrpyaesone/spring-rest-crud-helloworld

Purpose and Entry Point

A compact Spring Boot REST CRUD service for Person records backed by MySQL. The executable application entry point is src/main/java/com/ps/rest/crud/helloworld/SpringRestCrudHelloworldApplication.java; Maven build/dependency management is defined in pom.xml.

HTTP API Layer

src/main/java/com/ps/rest/crud/helloworld/controller/PersonCrudController.java exposes the REST-facing person CRUD operations. It is the boundary between HTTP request/response handling and the application’s service/data-access layers.

Domain Model

src/main/java/com/ps/rest/crud/helloworld/model/Person.java defines the person data shape exchanged through the controller and persisted in MySQL. This model is the shared contract across API, service, and database code.

Service and Persistence Abstraction

src/main/java/com/ps/rest/crud/helloworld/service/PersonCRUDRepo.java defines the person persistence/service contract, while src/main/java/com/ps/rest/crud/helloworld/service/PersonCRUDImplementation.java supplies its implementation. The controller should depend on this abstraction rather than directly on SQL-specific code.

MySQL Data Access

src/main/java/com/ps/rest/crud/helloworld/db/CRUD.java defines generic CRUD-oriented database behavior. src/main/java/com/ps/rest/crud/helloworld/db/MySQLImpl.java is the concrete MySQL integration, with database-related constants centralized in src/main/java/com/ps/rest/crud/helloworld/db/DBConstants.java. This is the material boundary between Java application logic and SQL/database connectivity.

Primary Flow

Requests flow: client → PersonCrudController → PersonCRUDRepo / PersonCRUDImplementation → CRUD / MySQLImpl → MySQL. Results return through the same layers as Person objects or API responses. SQL schema/seed setup is supplied separately at sql-data/crud_rest_helloworld.sql.

Runtime, Configuration, and Infrastructure

The runtime is Spring Boot on the JVM, packaged and built with Maven. Application/database settings are located in src/main/resources/application.properties and src/main/resources/application.yml. MySQL-oriented container infrastructure is provided by docker/spring-mysql-docker-compose.yml; docker/Dockerfile packages the application container. CI execution is configured in .circleci/config.yml.