Skip to content

Commit 6205a94

Browse files
committed
Add comprehensive Spring Boot documentation, including Actuator integration, configuration reference, and quick start guide.
1 parent e4e127d commit 6205a94

9 files changed

Lines changed: 3178 additions & 0 deletions

File tree

docs/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,18 @@ For experienced users:
113113
- [Performance Optimization](advanced/performance-optimization.md)
114114
- [Extending the Framework](advanced/extending-framework.md)
115115

116+
### Spring Boot Integration
117+
118+
Seamlessly integrate Aether Datafixers into Spring Boot applications:
119+
120+
- [Spring Boot Overview](spring-boot/index.md) — Introduction to the Spring Boot starter
121+
- [Quick Start](spring-boot/getting-started.md) — Add the starter and run your first migration
122+
- [Configuration Reference](spring-boot/configuration.md) — All configuration properties
123+
- [MigrationService API](spring-boot/migration-service.md) — Fluent migration API
124+
- [Multi-Domain Setup](spring-boot/multi-domain.md) — Managing multiple DataFixer instances
125+
- [Actuator Integration](spring-boot/actuator.md) — Health indicators and endpoints
126+
- [Metrics Integration](spring-boot/metrics.md) — Micrometer metrics for observability
127+
116128
### Support
117129

118130
- [Troubleshooting](troubleshooting/index.md)
@@ -129,6 +141,7 @@ For experienced users:
129141
| `aether-datafixers-api` | Core interfaces and API contracts |
130142
| `aether-datafixers-core` | Default implementations |
131143
| `aether-datafixers-codec` | GsonOps, JacksonOps implementations |
144+
| `aether-datafixers-spring-boot-starter` | Spring Boot auto-configuration, MigrationService, Actuator, Metrics |
132145
| `aether-datafixers-cli` | Command-line interface for data migration |
133146
| `aether-datafixers-testkit` | Testing utilities for DataFix, Schema, and migration testing |
134147
| `aether-datafixers-schema-tools` | Schema analysis, validation, and diffing utilities |

docs/getting-started/installation.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Aether Datafixers is modular. Choose the modules you need:
1111
| `aether-datafixers-api` | Core interfaces | Always (transitive dependency) |
1212
| `aether-datafixers-core` | Default implementations | Always needed for runtime |
1313
| `aether-datafixers-codec` | GsonOps, JacksonOps | When working with JSON |
14+
| `aether-datafixers-spring-boot-starter` | Spring Boot integration | For Spring Boot applications |
1415
| `aether-datafixers-cli` | Command-line interface | For CLI-based data migration |
1516
| `aether-datafixers-schema-tools` | Schema analysis and validation | For CI/CD validation, diffing, coverage |
1617
| `aether-datafixers-testkit` | Testing utilities | For unit/integration testing |
@@ -238,6 +239,27 @@ Aether Datafixers has minimal dependencies:
238239

239240
---
240241

242+
## Spring Boot Installation
243+
244+
For Spring Boot applications, use the dedicated starter module:
245+
246+
```xml
247+
<dependency>
248+
<groupId>de.splatgames.aether</groupId>
249+
<artifactId>aether-datafixers-spring-boot-starter</artifactId>
250+
</dependency>
251+
```
252+
253+
This includes auto-configuration for:
254+
- Automatic DataFixer bean creation from `DataFixerBootstrap` beans
255+
- `MigrationService` with fluent API
256+
- Health indicators and Actuator endpoints
257+
- Micrometer metrics integration
258+
259+
[Spring Boot Quick Start](../spring-boot/getting-started.md) — Get started with Spring Boot integration
260+
261+
---
262+
241263
## CLI Installation
242264

243265
For command-line usage without writing Java code, see the dedicated CLI documentation:

0 commit comments

Comments
 (0)