documenting-contracts

在记录 HTTP API、消息负载、队列契约、DTO、文件格式或 Webhook 时，或在编写旧版活动的 API 参考文档时，或当调用方不断询问某个字段的含义或某个端点返回哪些错误时，使用此方法。该方法编码了四个详细级别、DTO 优先的目录、带有源锚点的线类型、生成规范的单一归属规则，以及省略与 null 的语义。每当需要为调用方记录机器接口时，即使没有人说“API 文档”，也应使用此方法。

模型生成摘要（rules/v1 · 2026-11-13 18:16）：在记录 HTTP API、消息负载、队列契约、DTO、文件格式或 Webhook 时，或在编写旧版活动的 API 参考文档时，或当调用方不断询问某个字段的含义或某个端点返回哪些错误时，使用此方法
这是模型对公开材料的总结，不是官方声明，请以原链内容为准。

存档时间线

版本	存档时间	内容哈希	内容
v1	2026-11-13 18:16	93a763bd	可取

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本

纠错与举报（发现条目失效、署名有误或涉及侵权？）

提交举报 / 纠错

侵权举报经核验成立后，我们会即时下线该条目并删除已存的内容副本。