502-frameworks-micronaut-rest

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

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 annotations (@Operation, @Tag)
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.

为Micronaut HTTP应用应用REST设计原则。

本Skill涵盖哪些内容？

适用范围： 基于参考规则和代码示例（优/劣）应用建议。

Compile before REST refactors; verify after.

MANDATORY: Run
```
./mvnw compile
```
or
```
mvn compile
```
before applying any change
SAFETY: If compilation fails, stop immediately
VERIFY: Run
```
./mvnw clean verify
```
or
```
mvn clean verify
```
after applying improvements
BEFORE APPLYING: Read the reference for detailed rules and examples

在重构REST API前先编译；重构后进行验证。

Review or improve Micronaut @Controller REST APIs
Add validation, error handling, or OpenAPI documentation to Micronaut HTTP layer

For detailed guidance, examples, and constraints, see references/502-frameworks-micronaut-rest.md.

如需详细指导、示例和约束条件，请参阅references/502-frameworks-micronaut-rest.md。