Demo:只解释一个 checkout 接口
时序图最适合解释一个工作流。对 OpenAPI 来说,通常应选择一小组相关 path,而不是整份规范。
- 保留 POST /checkout 及关键成功/失败响应。
- 使用 operationId 或 summary 作为可读消息标签。
- 完整 OpenAPI 可以在文档里链接,不必全部塞进图里。
paths:
/checkout:
post:
operationId: createCheckout
summary: Create checkout session
responses:
"201": { description: Checkout created }
"402": { description: Payment required }聚焦输入比完整 API dump 更容易生成可读时序图。