./mvnw clean - Deletes target/ folder (build folder)

./mvnw package - Compiles .class files, runs tess, and packages into jar (./mvn compile just compiles)

./mvnw install - Compiles, packages, and installs to local m2 repo (<user>/.m2/repository)

./mvnw test - Runs unit tests

./mvn clean package - Deletes target/ folder and repackages (preferred way to build)

Swagger UI - */swagger-ui.html

(From api-service root folder)

./mvnw clean package

./mvnw.cmd clean package

(From app-service root dir)

java -jar target/api-service-0.0.1-SNAPSHOT.jar

JWT_ISSUER - (default: codesupport.dev)
JWT_EXPIRATION - (default: 10m)

DISCORD_APP_ID
DISCORD_APP_SECRET
DISCORD_APP_REDIRECT

LOG_ROOT_LEVEL - (default: INFO)
LOG_LOCAL_LEVEL - (default: ERROR) - Log level for app specific
SERVICE_PORT - (default: 8080)

DATABASE_URL
DATABASE_USERNAME
DATABASE_PASSWORD
DATABASE_DRIVER - (default: com.mysql.jdbc.Driver)
DATABASE_DIALECT - (default: org.hibernate.dialect.MySQLDialect)
DATABASE_POOL_SIZE - (default: 4) - Max number of allowed db connections
DATABASE_POOL_IDLE - (default: 2) - Minimum number of db connections to keep open

• Domain - Business model, handles business related validation (required fields, etc.)
• Controller - Defines the API contract and enforces it with validations.
• ControllerImpl - Translates HTTP requests to service calls, and can rarely help with supplemental API Contract validations, but no business logic. Handles simple parameter transformations prior to Service calls (i.e. parsing delimited strings to lists)
• Service - Business logic, handles bulk of logic in the request, gathering all data needed for the response.
• Repository - DAL (Data access layer), handles communication with DB
• Entity - DB Contract definition, and validation enforcement of that contract

All responses wrapped in RestResponse providing basic feedback from request.

• Status (OK, FAIL, WARNING, NOT_FOUND)
• Message (error/warning message if required)
• ReferenceId (ReferenceID to use for troubleshooting/logging)
• Response (The requested Resource)

dev.codesupport.web.api*

Resource logic

• Controllers (rest endpoints)

• Service Classes

• Entities

• Repositories

• Validation rules

  dev.codesupport.web.common.*

Framework

• Common utilities

• Error/Exception Handling

• CRUD framework

  dev.codesupport.web.domain.*

Rich domain models (Business models) used for API interactions and business validations

Domain level validations are done on the domain models via implementing the Validatable interface. This is for business validations such as required fields and field checks.

Persistence level validations are done via validation classes that extend the AbstractPersistenceValidation class, and are used for validation checks against the DB, such as unique column value checks.

Validations on the entities are only to protect the integrity of the database and enforce the DB contracts. No business logic validations done here (meaning no messages back to the user).

These validations are done on the API interfaces, and are used as basic API contract enforcements, done via the constraint annotations on the API interfaces. API implementations contain no validation checks.

Basic crud requirements are fulfilled (with preset mechanics) by utilizing the CrudOperations class.

getAll() - get all available entities
getById() - get by a specific id, throws `ResourceNotFoundException`, resulting in 404, if not found
createEntities() - saves entities to db, throws Exception if already exists by id, performs validation checks (domain & persistence level)
updateEntities() - updates entities in db, throws `ResourceNotFoundException`, resulting in 404, if not found, performs validation checks (domain & persistence level)
deleteEntities() - deletes entities from db, throws `ResourceNotFoundException`, resulting in 404, if not found

• GET - Get resource
• POST - Create resource
• PUT - Update resource
• DELETE - Delete resource

A consumable offered via API interaction

Naming for example resource: User

• User - Domain model (Business model)
• api/v1/users/{id} - Api uri (plural)
• UserController - API Contract (interface)
• UserControllerImpl - Api Contract implementation
• UserService - Service class (business logic)
• UserRepository - Data Access Layer
• UserEntity - DB Contract
• UserValidation - Persistence level validation

Any business logic exceptions throw ServiceLayerException in the service class. Validation and Resource exceptions are handled by the framework if utilizing provided APIs. All exceptions are caught and handled by the framework to provide feedback to the user and log to the system.

Any Questions? Feel free to mention @LamboCreeper#6510 in the CodeSupport Discord.