API Contract

SkillDev tools

Unifies API protocols, request/response formats, error codes, compatibility, and upstream/downstream collaboration constraints. Use when architects, frontend/backend developers, or QA need to lock down an API contract.

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the API Contract skill

What this skill tells your AI

The instructions your AI receives, as published by hashgraph-online/awesome-codex-plugins in plugins/Colin4k1024/tsp/skills/api-contract/SKILL.md and read by ahel’s review.

用途

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

默认做法

  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 的关键信息。

Signals

GitHub stars
985
Forks
276
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
api-contract-hashgraph-online
Source
github.com/hashgraph-online/awesome-codex-plugins