Skip to content

Getting Started

Welcome to SpringFlow! This section guides you through setting up and using SpringFlow for the first time.

In this section

  • Quick Start

    Create your first API in 5 minutes with SpringFlow

  • Installation

    Detailed installation and configuration guide

  • First Project

    Build your first complete project with examples

Prerequisites

Before you begin, make sure you have:

  • Java 17 or higher
  • Spring Boot 3.2.1 or higher
  • Maven 3.6+ or Gradle 7.0+

Quick Installation

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

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

Minimal Example

@Entity
@AutoApi(path = "products")
public class Product {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @NotBlank
    @Size(min = 3, max = 100)
    private String name;

    @Min(0)
    private BigDecimal price;
}

That's it! SpringFlow automatically generates:

GET /api/products — paginated list GET /api/products/{id} — single entity POST /api/products — create PUT /api/products/{id} — full update PATCH /api/products/{id} — partial update DELETE /api/products/{id} — delete

  1. Quick Start — start here to create your first API
  2. Installation — detailed configuration
  3. First Project — complete project with examples

Need help? See the full documentation or open an issue.