标签：编写规范

1. 接口文档需要包含哪些必备信息？ 一个合格的接口文档必须包含 接口概述、请求地址、请求方法、请求参数、返回示例、错误码 与 示例调用。每个参数应注明类型、是否必填、默认值与说明，错误码应统一规范并给出可复现的场景。 结构化字段与示例 建议用表格或 JSON 示例展示参数和返回体，关键字段使用 示例值 说明，必要时提供 序列化/反序列化 规