用 Mock JSON 反向生成接口 Schema
接口还没定文档?先造一份「看起来像」的 Mock JSON,反推出 Schema,契约就有雏形了。
适用场景
- 后端只给了「大概长这样」的样例,没有正式 schema。
- 前端要 mock 接口,需要先有个明确结构。
- 写接口文档时,用真实样例反推比手写更准。
步骤
- 准备一份尽量完整的 Mock JSON(覆盖你期望的所有字段、嵌套、数组)。
- 粘进工具,点「生成 Schema」。
- 在生成的 Schema 上补
required(工具默认把所有见到的字段都标成必填,按需删减)。 - 需要时再加
enum、minimum、format等约束。
注意
Mock 只代表你给的那条数据。如果真实接口有时返回 avatar: null,而 Mock 里没写,Schema 就不会体现「可空」。建议 Mock 把可能为空、可能为数组的字段都摆出来。