Welcome to Spring Rest Framework documentation!

Spring REST Framework (SRF) is a powerful library for Spring applications that brings the simplicity and flexibility of Django’s REST Framework to Spring. SRF streamlines API development with powerful serialization, flexible filters, and seamless integration.

Check out the Usage section for further information, including Installation of the package.

Contents

• Usage
  • Installation
  • Getting Started
• Generic Controllers
  • GenericListController
    • Example Usage
    • API Method
    • Constructor
    • Methods
  • GenericRetrieveController
    • Example Usage
    • Constructor
    • Methods
  • GenericCreateController
    • Type Parameters
    • Example Usage
    • Methods
  • GenericUpdateController
    • Type Parameters
    • Example Usage
    • Methods
  • GenericDeleteController
    • Type Parameters
    • Example Usage
    • Methods
  • GenericQueryController
    • Usage Example
    • API Methods
    • Methods
  • GenericCommandController
    • Example Usage
    • Endpoints
    • Customization Points
• Filters and FilterSet
  • FilterSet Class
    • Constructor
    • Methods
    • Builder
  • Filter
  • FilterOperation
• DTO
  • Introduction
  • Read-Only and Write-Only Fields
  • Field Exposure and Custom Mapping
  • Nested Model Field Mapping
  • Field Validation
  • Custom Serialization Logic
  • Static Method Transformations
  • Formatting Exposed Fields
  • postDeserialization() Method
• Security Configuration in Controllers
  • Defining Required Authorities for Generic Controllers
  • Defining Required Authorities for Generic Controllers with more than one HTTP method
• Architecture
  • Controller Layer
  • Service Layer
  • Utility Layer