VISUAL EXAMPLE
先看懂它怎么工作
维护规范文件
校验 schema
生成文档或代码
对照真实接口
MECHANISM
运行机制
- 维护规范文件
- 校验 schema
- 生成文档或代码
- 对照真实接口
USE WHEN
适合这样用
API 协作、SDK 生成和契约测试
NOT FOR
不要这样理解
不能写一份规范后长期不与实现同步
TELL YOUR AGENT
可直接发给 Agent
请按“OpenAPI 规范”的概念处理这个需求：让接口文档能生成客户端，并在 CI 中检查变更。。先说明实现边界，再给出可检查的结果。ACCEPTANCE
怎么确认它真的做好了
规范校验通过，示例可调用，接口变更会触发差异检查
OFFICIAL SOURCES