mcpField
4
402-frameworks-quarkus-rest

402-frameworks-quarkus-rest

github.com/jabrena开发456334 次安装1 天前更新
代码仓库

关于 402-frameworks-quarkus-rest

面向 Quarkus 与 Jakarta REST 的 REST API 审查和改进工作流技能，涵盖资源设计、验证、错误处理、并发控制及 HTTP 行为，并要求先编译、修改后完整验证。

主要功能

  1. 01JAX-RS 资源与 URI 设计
  2. 02验证与 RFC 7807 错误响应
  3. 03版本管理与幂等性
  4. 04ETag 并发控制与 HTTP 缓存
  5. 05分页、筛选与排序
  6. 06修改前编译及修改后验证

适用场景

  1. 01审查 Quarkus REST 资源
  2. 02添加验证和一致的错误响应
  3. 03实现分页或 API 版本管理
  4. 04通过构建验证 REST 修改

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/jabrena/plinth --skill 402-frameworks-quarkus-rest

安装后在 Claude Code 中输入/402-frameworks-quarkus-rest确认已加载。

附带文件references/402-frameworks-quarkus-rest.md

详细介绍

Quarkus REST API 指南

使用 Jakarta REST（JAX-RS）在 Quarkus 中应用 REST API 设计原则。

此技能涵盖哪些内容？

  • 资源类、@Path、HTTP 方法映射和资源 URI 设计
  • 状态码、Location 标头和 Response 构建
  • 边界处的 DTO 和 Bean Validation；日期/时间字段使用 ISO-8601
  • 使用 ExceptionMapper 生成一致的错误 JSON（RFC 7807 Problem Details）
  • API 版本控制策略（URI 路径、Accept 标头）
  • 使用 Idempotency-Key 标头实现幂等性
  • 乐观并发控制：ETag、If-Match、If-None-Match
  • 使用 Cache-Control 标头进行 HTTP 缓存
  • API 弃用：Sunset 和 Deprecation 标头
  • 分页、排序和筛选查询参数
  • 可选的 /openapi（通过 SmallRye）；在 openapi.yaml 中维护 API 优先契约（codegen）
  • 响应式与阻塞式处理注意事项；@RunOnVirtualThread
  • 在过滤器层集成安全机制

范围： 根据参考规则和正反代码示例应用建议。

约束

应用 REST 更改前，确保项目可以编译。改进完成后，运行完整验证。

  • 强制要求：应用任何更改前，运行 ./mvnw compile 或 mvn compile
  • 前提条件：应用 REST API 改进前，项目必须可以编译
  • 安全要求：如果编译失败，立即停止
  • 阻塞条件：编译错误必须由用户解决后才能继续
  • 验证：应用改进后，运行 ./mvnw clean verify 或 mvn clean verify
  • 应用前：阅读参考文档，了解详细规则和示例

何时使用此技能

  • 审查或改进 Quarkus 项目中的 JAX-RS 资源
  • 在 Quarkus 上设计带有验证和错误处理的 HTTP API
  • 添加 API 版本控制、幂等性、ETag 并发控制或弃用标头
  • 实现分页、排序或 RFC 7807 Problem Details 错误响应
  • 改进 Quarkus REST 资源和异常映射器

工作流

  1. 阅读参考文档并评估项目上下文

阅读 references/402-frameworks-quarkus-rest.md 并检查当前项目设置，然后再提出更改。

  1. 了解范围并确定目标改进

确定所需结果、约束以及要应用的最小安全更改集。

  1. 应用与框架一致的更改

按照参考模式和项目约定实现或重构配置/代码。

  1. 运行验证并报告结果

执行适当的构建/测试，并总结更改内容、验证结果和后续操作。

参考

详细指南、示例和约束请参阅 references/402-frameworks-quarkus-rest.md。

评论

支持 Markdown