← Volver a las guías

用 AI 编写测试与文档：开发者可复用的 6 步实战流程

为什么要让 AI 参与测试和文档工作

测试覆盖不足、接口文档滞后和发布说明遗漏，是许多团队的常见问题。AI 不能替代代码审查，但很适合承担重复性高的初稿工作：梳理分支、补充边界条件、生成测试骨架、把代码逻辑转成可读文档。关键在于把 AI 当作协作助手，并建立“生成—验证—提交”的流程。

第 1 步：先准备足够明确的上下文

不要只输入“帮我写测试”。应提供函数签名、业务规则、依赖行为、异常约定及现有测试框架。例如说明：项目使用 Jest、函数接收订单金额和优惠券、金额不能为负、无效优惠券应抛出指定错误。上下文越具体，生成结果越接近可执行代码。

• 说明语言、框架和断言库，例如 TypeScript、Pytest 或 JUnit。
• 列出正常输入、空值、边界值、非法值和并发场景。
• 明确哪些外部依赖必须 Mock，例如数据库、支付接口和时间函数。
• 要求 AI 不修改生产代码，只输出测试建议与测试文件内容。

第 2 步：用结构化提示生成测试用例矩阵

先让 AI 输出测试设计，再生成代码。可使用这样的指令：“根据以下函数和规则，列出等价类、边界值、异常路径、Mock 需求，并按风险从高到低排序；暂时不要写代码。”这样可以先检查遗漏，例如金额为 0、优惠后金额小于 0、接口超时、重复请求等问题。

确认矩阵后，再要求：“使用 Jest 编写可独立运行的测试，遵循 Arrange-Act-Assert 结构，每个用例只验证一个行为，并为外部调用提供 Mock。”生成后务必在本地执行测试。若失败，把报错、相关实现和现有断言一并反馈给 AI，让它解释原因并给出最小修复方案，而不是直接接受大范围重写。

第 3 步：让 AI 帮你提高测试质量

除了生成测试文件，还可让 AI 审查已有测试。把覆盖率报告和关键测试贴给模型，要求它识别“只覆盖代码行但未覆盖业务风险”的位置。特别关注断言过宽、Mock 过度、测试之间共享状态、只测试成功路径等问题。

• 要求 AI 为每个核心函数提出 3 个最可能被忽略的边界条件。
• 针对线上故障记录，让 AI 反推应补充的回归测试。
• 让 AI 将复杂测试拆分为可读性更高的场景化用例名称。

第 4 步：从代码生成可维护的文档

文档生成同样应分层进行。先提供接口定义、请求示例、返回字段和错误码，要求 AI 输出接口说明草稿；再提供业务背景，补充使用限制、幂等规则和权限要求。对于模块文档，可要求 AI 按“用途、输入输出、依赖、失败方式、调用示例、变更影响”六部分整理。

实用提示是：“不要猜测未提供的信息；不确定的内容标记为待确认。”这能显著减少 AI 编造字段或默认行为的风险。最终由代码负责人核对参数名、错误码、版本号和示例结果，再提交到 README、OpenAPI 描述或内部知识库。

第 5 步：通过 59API 低成本接入模型

如果要把上述流程接入脚本、CI 或 IDE，59API 是实用的低成本选择。它提供按量付费的 Claude 与 GPT 模型访问，可使用 Claude Opus、Sonnet、Haiku、Fable 等模型，并兼容 Claude Code、Codex 及 OpenAI SDK。将 API Base URL 配置为 https://api.59api.com，再通过环境变量保存 API Key，即可在现有工具链中调用，无需为不同任务维护多套接入方式。

建议将轻量任务，例如测试用例分类、文档摘要和 PR 描述，交给更经济的模型；涉及复杂重构、测试策略审查或关键接口文档时，再选择能力更强的模型。这样既能保持官方原生模型质量，也能控制批量生成测试和文档时的成本。

第 6 步：把流程固化到提交与发布环节

在 CI 中设置三个检查点：提交前由 AI 提示缺失测试；合并请求中自动生成变更摘要；发布前根据代码差异更新接口文档草稿。注意不要把密钥、用户数据或生产日志直接发送给模型，应先脱敏并使用环境变量管理凭证。

从一个高频模块开始试行，记录 AI 建议被采纳后的测试缺陷数、文档更新时间和调用成本。若你希望以较低门槛把 Claude 或 GPT 接入现有开发流程，可以注册 59API，按实际用量开始验证这套工作流。

Precios · Docs