我将为API交钥匙编写技术文档

我已经为API编写技术文档多年，知道如何将一个正常工作的后端和分散的开发者笔记转化为一个合作伙伴可以在一天内集成的文档，而不是一周的支持通信。我曾在金融科技、物流和SaaS产品中使用REST和GraphQL服务。

在开始工作之前，我会研究你的代码或规范，向开发团队询问有争议的点，然后在描述每个方法之前自己测试每个方法——我不会盲目相信旧笔记。在完成的文档中，我描述每个方法的目的，所有参数及其类型和默认值，提供JSON格式的请求和响应的真实示例以及错误代码。当它加快集成时，我会设置一个互动页面，让合作伙伴可以直接从浏览器发送测试请求，并立即看到实时响应。

完成包中包含的内容：
— 每个方法的描述，包括参数、类型和默认值
— 成功和错误案例的请求和响应的工作示例
— 连接到你的沙箱的互动测试页面
— 带有变更历史和版本说明的简短部分

我使用精确和一致的语言编写，如果已经建立了你的风格，我会遵循，并提供你的支持团队可以独立维护的文档。