How imransolanki/kotlin-microservices-starter-kit works
Project type and purpose
• This is a standalone Kotlin microservice built with the Ktor HTTP framework. It exposes a simple “Pet” API, applies business logic in a service layer, persists data to PostgreSQL via Exposed, and uses Koin for dependency injection and Hoplite for configuration.
File structure
• Top-level: build files (Gradle), README, settings.
• src/main/kotlin/org/edu/api: HTTP models and route definitions (Pet.kt, PetRoutes.kt, Validator).
• src/main/kotlin/org/edu/service: business logic (PetService).
• src/main/kotlin/org/edu/persistence: database entity definitions (PetEntity).
• src/main/kotlin/org/edu/plugin: application wiring (AppModule, Configuration, DataSource, DatabaseConfig, EnvironmentConfig), Ktor plugin setup (Routing, Serialization), and SchemaMigrator for DB migrations.
• src/main/resources: application.yaml (Hoplite configuration), SQL migration scripts, logging config.
• Tests mirror API and service layers (Kotest).
README
• Confirms use of Ktor, Koin, Exposed, Either, Hoplite, and Kotest.
• Describes features: modular microservice, best practices, PostgreSQL backend.
Main components and interactions
a. Components:
• Client (HTTP consumer)
• Ktor HTTP server
• Routing plugin (registers PetRoutes)
• API layer (PetRoutes + Validator)
• Service layer (PetService, uses Either for error handling)
• Persistence layer (Exposed DAOs in PetEntity, SchemaMigrator)
• Configuration (Hoplite loading application.yaml → EnvironmentConfig)
• Dependency injection container (Koin via AppModule)
• DataSource (DatabaseConfig → HikariCP → PostgreSQL)
• External PostgreSQL database + migration scripts
b. Relationships & data flow:
1. Client → HTTP request
2. Ktor Routing → PetRoutes
3. Input validated via Validator → request DTO (Pet)
4. PetRoutes calls PetService
5. PetService uses Exposed DAO (PetEntity) to query/update DB
6. SchemaMigrator runs at startup to apply SQL migrations
7. Responses serialized → client
c. Architectural patterns & principles:
• Layered architecture (API → Service → Persistence → DB)
• Dependency injection (Koin modules wired in AppModule)
• Configuration abstraction (Hoplite)
• Database migrations at startup
• Error handling via Either monad
d. Key technologies:
• Ktor (HTTP server, Routing, Serialization)
• Koin (DI)
• Exposed (ORM)
• Hoplite (config)
• Kotest (tests)
• PostgreSQL