Skip to content
Getting Started

Getting Started

Getting Started

Add transparent failover to any Spring Boot service in two steps — one dependency, one annotation.

flowchart LR
    A["① Add starter\ndependency"] --> B["② Annotate your\nSpring bean method"]
    B --> C(["✅ Failover active"])

  • Installation

    Maven and Gradle coordinates for the starter and every individual module. Covers BOM imports and optional module declarations.

    Add the dependency

  • Quickstart

    Working end-to-end example in 5 minutes — one dependency, one annotation, one config block, and a failing test to prove it works.

    Follow the guide

Spring beans only

@Failover intercepts calls through the Spring AOP proxy. Annotate methods on @Service, @Component, @FeignClient, or any Spring-managed bean. Self-invocation (calling a @Failover method from within the same class) bypasses the proxy and has no effect.

Next Steps