用WorkBuddy把API文档变成可运行的调用示例

一、痛点

对接一个新接口，文档往往是一长串字段说明和示例 JSON。真要写调用代码，还得自己拼 URL、填参数、处理返回。联调阶段尤其烦：文档看半天，代码写半天。

本文用一个提示词，让 WorkBuddy 把接口文档直接转成可运行的调用示例。

二、准备

1. 打开 WorkBuddy 并登录
2. 新建对话
3. 准备好接口文档片段（可以是文字、截图里的文字，或一段 curl 示例）

三、操作步骤

步骤 1：提交文档并提需求

把文档粘贴进对话，并输入：

步骤 2：确认示例

WorkBuddy 会返回一段完整可运行的代码。你可以继续要求：

• 改成异步（aiohttp / httpx）
• 抽成可复用的函数或类
• 补上返回字段的说明注释

步骤 3：本地运行验证

保存为 .py 文件，填入真实的接口地址和密钥后运行，确认能拿到返回。

四、输出大概包含什么

一个典型示例会包含：

• 请求地址与方法的常量定义
• 请求头（含鉴权占位，如 Authorization: Bearer ）
• 参数组装与发送
• 返回解析与异常捕获

具体实现以 WorkBuddy 实时返回为准，按你的实际接口调整即可。

五、进阶

• 一次贴多个接口，让它生成一套调用封装
• 让它同时生成配套的单元测试（用 mock 模拟返回）
• 指定目标语言，如改成 Go 或 Node.js 版本

六、小结

把文档转成能直接跑的代码，联调效率明显提升，也减少手写拼接出错。适合新接口接入、第三方 SDK 快速试水。