Skip to content

hashgraph-online/awesome-codex-plugins / plugins/Colin4k1024/tsp/skills/api-contract

api-contract

Unverified

统一接口协议、请求响应、错误码、兼容性与上下游协作约束。 当架构师、前后端开发或 QA 需要锁定 API 合同时使用。

API Contract

用途

  • 定义或审阅接口契约,避免“实现先行、契约滞后”。
  • 对齐请求响应、鉴权、兼容性与错误处理。

默认做法

  1. 使用 api-contract.md 固定接口定义。
  2. 记录调用方、鉴权要求、错误码和兼容策略。
  3. 若契约以 OpenAPI 形式维护,先结合 api-lint-gates 校验规范与结构,再用 api-breaking-change-gates 做兼容性比对。
  4. 若接口存在明确的 consumer/provider 边界,且需要把行为约定做成可执行验证,再结合 contract-testing-playbook 规划 pact 或 provider verification。
  5. 指明需要同步给前端、后端、QA 的关键信息。
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 318kUpdated Claude CodeCodexUnverifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 318kUpdated Claude CodeCodexUnverifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 318kUpdated Claude CodeCodexUnverifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 196kUpdated Claude CodeCodexVerifiedInstall