如何让更多开发者使用你的 API

作为 Baklib 的研究员，我经常和产品团队、开发者打交道，发现一个很普遍的现象：公司花了大把精力做 API，结果开发者的采用率却低得可怜。问题往往不在 API 本身，而在于开发者体验——从第一次接触、试用文档，到真正集成，每一步都可能是劝退点。如果你正在为 API 的推广发愁，那这篇文章就是为你准备的。我们聊聊如何用策略和工具，让开发者心甘情愿地把你的 API 用到日常开发里。

任何想多卖产品的公司，核心策略都是吸引更多客户。同理，想让开发者用你的 API，就得像营销人员一样思考——开发者就是你的目标受众。你得了解他们从 API 中想要什么、用哪些技术、在什么行业工作、专业水平如何等等。简单说，要吸引他们，先得理解他们。

怎么了解目标受众？一个高效的方法是做调研，构建开发者用户画像。

正如开发者营销专家 Teresa Garanhel 指出的，没有数据就谈不上画像。所以，先收集数据。问卷是个好方式。用 Google Forms 或 Typeform 这类在线工具很容易创建，再通过线上渠道分发。问卷的问题要简单好答，提高回收率。

比如，曾在 Uber 和 Stripe 任职的软件工程师 Will Larson 的开发者问卷，就用了下拉菜单让开发者快速选择。无论你用什么方法，收集数据的目的是更好地理解受众。然后创建用户画像——一个虚构的人物，代表一群开发者。你可以根据初级/高级、后端/前端等维度创建多个画像。有了清晰的画像，就能更有针对性地吸引他们。

总有些开发者很难说服。但如果你让他们免费、无义务地试用，最怀疑的人也难拒绝。方式就是提供一个 API 沙箱。

技术顾问 Ivanin Ivanov 解释：API 沙箱是一个仿真器，位于测试 API 后面，给外部开发者提供一个自我测试的环境。简单说，沙箱是一个安全、无风险的环境，开发者可以自由测试任何东西。例如，金融科技公司 Fiserv 就提供了沙箱，开发者输入参数点击“运行”就能看到响应。沙箱模拟真实生产环境，开发者能直观了解 API 能力，自然更有动力使用真实 API。

搭建沙箱的方法很多，用 Docker Compose 是简单的一种，无需昂贵的服务器基础设施即可仿真环境。

直说吧——想要更多开发者用你的 API，就得提供出色的文档。因为开发者首先会去查阅 API 文档来了解 API 如何工作。所以，你应创建一份能让他们快速上手的资源。

看看 Postman 的《2022 API 状况报告》：26% 的开发者给 API 文档打 5 分（满分 10 分），仅 3% 的开发者认为文档“非常好”。那么，什么样的文档能得 10 分？理想情况下，文档应直接、清晰，通过例子和教程演示 API 用法。软件专家 Jordan Ambra 说，这正是优秀文档与合格文档的区别：“它能帮助用户理解 API 并找到起点，让 API 进入他们的脑海。”

Todoist 的 API 文档就是个好例子：可理解、分步引导、示例紧邻文字。用 Baklib 来创建 API 文档能省不少时间，Baklib 可自动生成 API 引用，上传 API 定义文件即可，几秒内生成。让制作顶级 API 文档变得轻松。

别低估简单和便捷的力量。如果 API 把这些因素考虑进去，开发者会毫不犹豫使用。他们每天任务繁重，如果你能让他们轻松接入和使用，这将是他们最乐意做的事。

数据专家 Jarkko Moilanen 指出，开发者越快意识到 API 的价值，他们继续使用的可能性就越高。简单说，要“把 API 放在银盘子里端给开发者”。比如简化注册和认证流程。只收集基本信息，允许一键登录（用 Google、GitHub 等账号）。另外，通过演示让开发者快速了解 API 如何工作。例如 Pusher 在网页上提供了快速演示，用户点击即可试推送通知，并修改代码中的“title”和“body”文本。实践证明，这种立即可用的体验能显著提高采用率。

---

Baklib Community 社区平台帮助组织解答有关其业务的所有问题。Baklib 的 Community Platform 收集内容并将其组织成知识图谱，然后利用一组互补的产品（包括列表、页面、评论和搜索）在客户、员工和合作伙伴寻找信息的任何地方提供相关且可操作的答案。5 年来，全球数千家公司信赖 Baklib 能够在搜索引擎、网站、移动应用和数百个其他数字接触点上大规模创建无缝的内容驱动体验。