用途:把接口当作与消费者之间的持久约定来设计,而非路由清单。适用于新建或变更 REST/HTTP API、GraphQL schema、RPC 操作、事件或消息契约、Webhook、流式接口,在实现前及任何消费者可见行为变化时使用。不适用于 ADR 模板、完整产品发现、安全评估或实现测试计划,这些分别交给 adr-authoring、product-discovery、secure-software-engineering、verification-methodology。
主要能力:先分类范围,跨多个接口时用 templates/api-landscape-assessment.md 并读 references/api-landscape-and-governance.md;涉及流量准入、路由、观测或隔离时读 references/api-infrastructure-topologies.md。发现约定:说明消费者任务、领域术语与不变量、权威数据与 schema 归属、参与者、对象/动作权限边界、数据敏感性与失败模式,未决问题如实记录。选择接口形态:比较交互方向、耦合、投递需求、查询灵活性、变更语义、缓存、可观测性与演进面,读 references/interface-selection.md。显式化契约:定义表示及其语义,包括 null 与缺失、默认值、枚举/联合、标识符、时间戳、单位、排序、过滤与分页,用 templates/endpoint-contract.md 与 references/contract-semantics.md。设计变更与失败行为:定义权限检查、前置条件、幂等范围与等价性、重试、并发、部分结果、长时操作状态、错误与资源限制,读 references/operations-and-failures.md,共享错误时建 templates/error-taxonomy.md。异步投递:消息、Webhook、流需说明发布/订阅视角、信封、投递契约、重复/缺口/乱序、排序范围与安全边界,读 references/events-webhooks-streaming.md。从每个消费者视角评估变更:清点消费者、生成客户端、严格解码器、签名、缓存、配额与运维依赖,完成 templates/compatibility-change-assessment.md,不能仅因是增量就判定安全。规划并验证发布:弃用或迁移用 templates/deprecation-migration-plan.md 与 references/evolution-and-deprecation.md,用 templates/contract-review.md 评审契约,测试提供方一致性、消费者预期、兼容性差异、示例、负例与部署边界;兼容策略确定后加载 release-engineering 处理发布排序、制品晋级、渐进暴露与协调回滚。
限制:安全边界上,契约需记录认证要求与服务端对象/动作授权,但威胁模型、凭据处理、租户隔离、不可信 URL 或文件、Webhook 签名设计、输出最小化、脱敏与抗滥用应加载 secure-software-engineering;API 契约无法证明授权边界已执行。所有权上,产品负责人决定消费者结果、受众、价值与生命周期意图;平台负责人决定网关、入口、网格、网络、部署与运行时;安全负责人决定威胁模型与凭据控制;架构负责人决定跨系统原则与重大边界。景观评估不是产品路线图、平台运行手册、安全评审或企业架构库。完成条件:所选接口有负责人、权威契约、明确的消费者与失败假设、每次变更的兼容性评估,以及每个必需评审项的证�据或明确缺口;未决的领域语义、权限、投递或消费者影响问题应升级给责任方。