api-contract-governance

A set of rules for keeping backend REST APIs and frontend clients consistent in how they return data, pages, errors, and login results.

In plain words
What is it for?
Use it when adding or changing REST endpoints, connecting frontend API calls, fixing pagination or error handling, and checking authenticated requests.
Why use it?
It removes mismatches such as the frontend reading outdated response fields or treating the wrong status value as success.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/sourcelin/sourcelin-cloud-blog/api-contract-governance
Any agent
npx skills add SourceLin/sourcelin-cloud-blog --skill api-contract-governance
Clone the repo
git clone --depth 1 https://github.com/SourceLin/sourcelin-cloud-blog

Made for: Claude Code, Codex.

Per session 30 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 531 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00030 $0.00531
Opus 5 $0.00015 $0.00266
Sonnet 5 $0.00006 $0.00106
Haiku 4.5 $0.00003 $0.00053

Measured 2d ago against content hash 5c4a7fdbe38f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-contract-governance scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/api-contract-governance/SKILL.md · 49 lines

What it actually says

API 契约治理技能

使用场景

  • 新增或改造后端 REST 接口。

  • 前端接入或修改 API 消费。

  • 修复响应体、分页、错误码或登录态接口验证失败。

  • 对齐 Controller、前端 API 类型和页面消费字段。

输入

  • 待治理接口路径、Controller、前端 API 文件或接口失败列表。

  • 当前统一响应体、分页、错误码和登录态验证要求。

输出

  • API 契约一致的后端和前端改动。

  • 更新后的接口说明或验证记录。

  • 后端编译、单测、前端类型检查或 HTTP 验证结果。

执行步骤

  1. 读取 rules/api-contract.mdrules/testing-and-validation.md

  2. 扫描 Controller 是否存在手动 ApiResponse、对外 R<T>AjaxResultTableDataInfo、旧分页参数。

  3. 扫描前端是否读取 msg/rows/records/list、判断 code === 200 或使用旧字段 fallback。

  4. 后端按业务对象、ListResult<T>PageResult<T>IdResponseVoid 修复。

  5. 前端按 request 解包后的业务数据和标准分页字段修复。

  6. 涉及运行态验证时,使用本地临时登录态执行真实 HTTP 请求,不把账号、密码、token、cookie 写入仓库。

  7. 按影响范围执行 Maven、npm 或 pnpm 验证;失败先修复再继续。

依赖 rules

  • rules/api-contract.md

  • rules/testing-and-validation.md

  • rules/coding-conventions.md

禁止行为

  • 禁止保留旧字段兼容层。

  • 禁止将 code === 200 作为成功判断。

  • 禁止用 items ?? list 或同类 fallback 掩盖后端问题。

  • 禁止把账号、密码、token、cookie 写入仓库。

  • 禁止把 Feign R<T> 暴露给前端 REST。

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 49 lines · 30 tokens per session scan A 5c4a7fdbe38f

Subscribe to this mod's changes

api-contract-governance is a skill published in the GitHub repository SourceLin/sourcelin-cloud-blog (20 stars, last pushed 2mo ago), licensed MIT. It adds 30 tokens to every session and 531 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens