Avaje Nima Guides
Step-by-step guides for common tasks in avaje-nima projects. Each guide is maintained as Markdown in the avaje-nima repository — follow the links below to read them on GitHub.
| Guide | Description |
|---|---|
| Archetype scaffolding | Generate a new avaje-nima project with Maven archetype — understand project structure, learn compilation steps, and explore customization patterns. |
| Global exception handler | Add a centralised exception handler that catches exceptions from any controller and maps them to structured JSON error responses with correct HTTP status codes. |
| Testing controllers | Write integration tests for controllers using avaje-nima-test and @InjectTest. Tests run against a real embedded Helidon server — no mocking framework needed. |
| JVM Docker image with Jib | Add a Jib Maven plugin configuration so that mvn package automatically builds a JVM Docker image — without writing a Dockerfile. |
| GraalVM native image with Jib | Add a native Maven profile that compiles the application to a GraalVM native executable and packages it into a Docker image using Jib. Activate with mvn package -Pnative. |
AI coding agents
AI agents (GitHub Copilot, Cursor, Claude Code, etc.) should refer to the avaje-nima guides index for step-by-step guidance on these same tasks — the guides are authored specifically for AI consumption and include exact XML and Java snippets to insert.