Demo:API 文档发布前 review 请求 schema
Schema 图最有价值的地方,是让必填字段、数组对象和组合结构一眼可见。
- 必填字段应该和可选 metadata 明确区分。
- enum 通常会变成 UI 状态或 SDK 常量,需要清楚展示。
- oneOf 和 anyOf 需要文档解释,不应只靠图里的分支。
{
"type": "object",
"required": ["email", "plan"],
"properties": {
"email": {"type": "string", "format": "email"},
"plan": {"type": "string", "enum": ["free", "pro"]},
"metadata": {"type": "object", "additionalProperties": true}
}
}这个小 schema 已经包含必填字段、枚举状态和开放 metadata。