Micronaut REST API Guidelines

Apply REST design principles for Micronaut HTTP applications.

What is covered in this Skill?

• Semantic HTTP with @Get/@Post/@Put/@Patch/@Delete and HttpResponse status control
• Resource-oriented paths and stable DTO contracts
• @Valid on request bodies with Bean Validation
• Centralized error mapping (ExceptionHandler / problem JSON when applicable)
• Pagination with Pageable and bounded sizes
• OpenAPI contract file (API-first) and OpenAPI Generator for server stubs
• Security annotations (@Secured) on sensitive routes
• Idempotency-Key for retried writes
• ETag / If-Match for optimistic concurrency
• Cache-Control discipline
• API versioning patterns
• ISO-8601 time types in DTOs

Scope: Apply recommendations based on the reference rules and good/bad code examples.