API Reference

Complete technical reference for the SpringFlow API.

References

• Annotations API

  ---

  All annotations with detailed parameters

• Configuration Properties

  ---

  springflow.* YAML properties

• Generated Endpoints

  ---

  Automatically generated REST endpoints

Overview

Core Annotations

Annotation	Description	Target
@AutoApi	Enables API generation	Entity
@Filterable	Enables dynamic filtering	Field
@Hidden	Excludes field from DTO	Field
@ReadOnly	Output only, not accepted in input	Field
@SoftDelete	Enables logical deletion	Entity
@Auditable	Automatic audit trail	Entity

Configuration Properties

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

Generated Endpoints

For each entity annotated with @AutoApi, SpringFlow generates:

Method	Endpoint	Description
GET	/api/{path}	Paginated list
GET	/api/{path}/{id}	Single entity
POST	/api/{path}	Create
PUT	/api/{path}/{id}	Full update
PATCH	/api/{path}/{id}	Partial update
DELETE	/api/{path}/{id}	Delete

Detailed Documentation

• Annotations API — parameters, examples, use cases
• Configuration Properties — all configuration options
• Generated Endpoints — request and response formats

---

For practical examples, see the User Guide.