适用场景
- 接手老项目,接口全靠读代码猜
- 参数含义不明,改一处要翻半天调用链
- 要交接给别人,文档得先补出来
PROMPT
接手一个跑了六年的 PHP 项目,用户查询接口没有一行文档,参数 `$type` 不知道传什么。要补一份能交接的文档,用它。 【需求】 1 代码是一个老 PHP 项目的用户查询接口,只贴核心片段 2 接口路径是 /api/user/list,需要 token 鉴权 3 参数里有 $type,代码里只用于 switch 分支,含义不明 4 返回结构没有统一封装,成功和失败格式不同 5 需要文档能直接交给新人 【输出要求】 1 先给接口概览:请求方法、路径、用途一句话、鉴权方式 2 给参数表,列含字段名、类型、是否必填、含义、取值范围 3 取值不明的地方标待确认,不要猜一个看起来合理的含义 4 返回结构给成功和失败两个示例 JSON,字段后加中文注释 5 给一段可直接跑的 curl 示例,含 header 6 列隐患清单至少 2 条,指出从代码里能看出的风险