api-contract-review

仓库创建 2026年1月30日最近提交 5 个月前SkillHot 收录 23 天前

▸ 精选理由

面向发布前或 PR 审核的实用检查清单与常见问题

这个 Skill 做什么

审查 REST API 合约的语义、版本与兼容性问题

把 REST API 的接口合约检查一遍，重点看 HTTP 语义、状态码、版本控制和向后兼容性。通常在发版前、PR 审查或改接口时用。特色是能识别错误的 HTTP verb、返回不一致或破坏兼容的变更，并给出修复建议。

▸ 展开 SKILL.md 英文原文

Review REST API contracts for HTTP semantics, versioning, backward compatibility, and response consistency. Use when user asks "review API", "check endpoints", "REST review", or before releasing API changes.

开发编程API审计兼容性HTTP语义Claude Code

692

Stars

135

Forks

仓库内 Skill

+20

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/decebals/claude-code-java/main/.claude/skills/api-contract-review/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/decebals/claude-code-java/main/.claude/skills/api-contract-review/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# API Contract Review Skill

Audit REST API design for correctness, consistency, and compatibility.

## When to Use
- User asks "review this API" / "check REST endpoints"
- Before releasing API changes
- Reviewing PR with controller changes
- Checking backward compatibility

---

## Quick Reference: Common Issues

| Issue | Symptom | Impact |
|-------|---------|--------|
| Wrong HTTP verb | POST for idempotent operation | Confusion, caching issues |
| Missing versioning | `/users` instead of `/v1/users` | Breaking changes affect all clients |
| Entity leak | JPA entity in response | Exposes internals, N+1 risk |
| 200 with error | `{"status": 200, "error": "..."}` | Breaks error handling |
|

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有