Api contract

Api contract

Skill Colin4k1024/tsp/skills/api-contract

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

Install

npx -y skills add Colin4k1024/tsp --skill api-contract

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.0 KB, as published. Nobody here has run it

API Contract

用途

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

默认做法

使用 api-contract.md 固定接口定义。
记录调用方、鉴权要求、错误码和兼容策略。
若契约以 OpenAPI 形式维护，先结合 api-lint-gates 校验规范与结构，再用 api-breaking-change-gates 做兼容性比对。
若接口存在明确的 consumer/provider 边界，且需要把行为约定做成可执行验证，再结合 contract-testing-playbook 规划 pact 或 provider verification。
指明需要同步给前端、后端、QA 的关键信息。