Installation¶

This guide covers detailed installation and configuration of SpringFlow in your Spring Boot application.

Prerequisites¶

Java: 17 or higher
Spring Boot: 3.2.1 or higher
Build Tool: Maven 3.6+ or Gradle 7.0+

Maven Installation¶

Add the SpringFlow starter dependency to your pom.xml:

<dependency>
    <groupId>io.github.tky0065</groupId>
    <artifactId>springflow-starter</artifactId>
    <version>0.5.1</version>
</dependency>

Gradle Installation¶

Add the dependency to your build.gradle:

implementation 'io.github.tky0065:springflow-starter:0.5.1'

For Gradle Kotlin DSL (build.gradle.kts):

implementation("io.github.tky0065:springflow-starter:0.5.1")

Configuration¶

SpringFlow works with zero configuration by default, but you can customize behavior in application.yml:

springflow:
  enabled: true
  base-path: /api
  base-packages: com.example.myapp
  pagination:
    default-page-size: 20
    max-page-size: 100
  swagger:
    enabled: true

See Configuration Guide for all available options.

Verification¶

After adding the dependency, start your application:

./mvnw spring-boot:run

Check the logs for SpringFlow initialization:

INFO  AutoApiRepositoryRegistrar - Starting AutoApi Repository, Service, and Controller Registration...
INFO  AutoApiRepositoryRegistrar - AutoApi registration completed. Registered X entities.

Visit Swagger UI at: http://localhost:8080/swagger-ui.html