User Guide

Complete reference for SpringFlow features and how to use them.

Contents

Core Features

• Annotations

  ---

  Complete reference for all SpringFlow annotations

• Configuration

  ---

  Configuration options via YAML and annotations

• DTO Mapping

  ---

  Automatic entity-to-DTO mapping

Data Management

• Filtering

  ---

  Dynamic query filtering with @Filterable

• Pagination & Sorting

  ---

  Paginate and sort results

• Validation

  ---

  Data validation with JSR-380

Advanced Features

• Security

  ---

  Spring Security integration and access control

• Soft Delete

  ---

  Logical deletion with restore support

• Auditing

  ---

  Automatic audit trail (createdAt, updatedAt, etc.)

• Kotlin Support

  ---

  Using SpringFlow with Kotlin and data classes

Where to start?

If you are new to SpringFlow, we recommend reading in this order:

1. Annotations — understand @AutoApi and field-level annotations
2. Configuration — customize the behavior
3. DTO Mapping — understand automatic mapping
4. Pagination — handle large collections

Then explore the advanced features based on your needs.

Quick Reference

I want to...

• Create a simple API → Annotations
• Filter results → Filtering
• Paginate results → Pagination
• Validate data → Validation
• Secure endpoints → Security
• Track changes → Auditing
• Support restore → Soft Delete
• Use Kotlin → Kotlin Support

---

Need help? Check the advanced topics or the API reference.