关于 502-frameworks-micronaut-rest
用于设计和改进 Micronaut HTTP 应用 REST API 的编码技能，涵盖端点语义、验证、错误处理、分页和 API 契约，并要求修改前编译、修改后验证。
主要功能
- 01HTTP 方法与响应状态设计
- 02请求验证和集中式错误处理
- 03分页与 OpenAPI 契约建议
- 04安全、缓存和版本管理模式
- 05修改前编译并进行完整验证
适用场景
- 01审查 Micronaut REST 控制器和 DTO
- 02添加请求验证或错误处理
- 03使分页和 API 与 OpenAPI 契约一致
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/502-frameworks-micronaut-rest确认已加载。
附带文件references/502-frameworks-micronaut-rest.md
详细介绍
Micronaut REST API 指南
将 REST 设计原则应用于 Micronaut HTTP 应用。
此技能涵盖哪些内容？
- 使用 @Get/@Post/@Put/@Patch/@Delete 实现语义化 HTTP，并通过 HttpResponse 控制状态
- 面向资源的路径和稳定的 DTO 契约
- 在请求正文中使用 @Valid 和 Bean Validation
- 集中式错误映射（适用时使用 ExceptionHandler / problem JSON）
- 使用 Pageable 实现分页，并限制页面大小
- OpenAPI 契约文件（API 优先）和用于生成服务端存根的 OpenAPI Generator
- 在敏感路由上使用安全注解（@Secured）
- 为可重试写入使用 Idempotency-Key
- 使用 ETag / If-Match 实现乐观并发控制
- 遵循 Cache-Control 规范
- API 版本控制模式
- 在 DTO 中使用 ISO-8601 时间类型
**范围：**根据参考规则以及优劣代码示例应用建议。
约束
重构 REST 前先编译；完成后验证。
- 强制要求：进行任何更改前，运行
./mvnw compile或mvn compile - 安全要求：如果编译失败，立即停止
- 验证要求：应用改进后，运行
./mvnw clean verify或mvn clean verify - 应用更改前：阅读参考资料，了解详细规则和示例
- 边界情况：如果请求范围不明确，在应用更改前停止并提出澄清问题
- 边界情况：如果缺少必需的输入、文件或工具，请说明缺少的内容，并询问是否继续提供设置指导
何时使用此技能
- 审查或改进 Micronaut @Controller REST API
- 在 Micronaut HTTP 层添加验证、错误处理，或使控制器符合 OpenAPI 契约
- 设计 Micronaut 控制器和 DTO 验证
- 添加 Micronaut 异常处理程序和 Problem Details 响应
- 改进 Micronaut API 中的分页、筛选或 OpenAPI 对齐
工作流
- 阅读参考资料并评估项目背景
阅读 references/502-frameworks-micronaut-rest.md，并检查当前项目设置，然后再提出更改建议。
- 明确范围并确定改进目标
确定所需结果、约束，以及要应用的最小安全变更集。
- 应用符合框架规范的更改
按照参考模式和项目惯例实现或重构配置与代码。
- 运行验证并报告结果
执行适当的构建和测试，并总结更改内容、验证结果以及后续操作。
参考资料
详细指南、示例和约束，请参阅 references/502-frameworks-micronaut-rest.md。
评论
支持 Markdown