对于普通开发者来说，API文档质量的重要性

随着企业寻求简化工作流程并降低成本，流行的低代码和无代码工具（例如 Thunkable、Bubble 和 Webflow）正被越来越多地采用。然而，如果没有足够的文档，这些工具可能会很快失去采用。

我们与高级产品经理 Wil Kirwan 进行了交谈，探讨了低代码和无代码解决方案的未充分服务的市场，以及如何通过高质量文档推动 API 的采用。

低代码开发者与传统开发者有何不同？

重要的是要认识到，低代码开发人员（也称为平民开发人员）不是典型的软件开发人员。通常，他们在组织中还有其他工作，但仍在构建非常有用的工具，并推动采用您的 API 来构建这些工具。Kirwan 举的一个例子是一位平民开发人员为停车场创建车牌识别应用程序。他并没有打算创建 API，但最终他需要一个 API 来完成他面临的挑战，即将罚单链接到特定的车库。

现在，仅仅因为他们正在开发和使用 API，并不意味着他们理解记录这些 API 的重要性，就像典型的软件开发人员可能会想到的那样。如果您不记录这些 API 的交互方式，那么您将错失一个巨大的扩展机会。

“虽然一些开发人员并不总是能自己解决问题，但如果你给他们一些有据可查的用例，他们就会想到多种使用你的 API 的方法，并将其应用到其他低代码项目中，”Kirwan 分享道。

如何通过文档吸引低代码开发者？

避免疏远低代码开发人员的最佳方法是提供带有图片和流程图的丰富文档。为什么还有其他形式的媒体？Kirwan 解释说：“这种类型的文档对于技术水平较低的用户很有用，可以帮助他们理解 API 之间的定义关系。”

API 文档的最大问题之一是它通常停留在“发送请求，获得结果”阶段。然而，有效的文档应该超越这一点，提供分步指南，帮助开发人员了解整个 API 生命周期。例如，电动汽车充电供应商的文档可以包括流程图、所有端点以及启动电动汽车充电器的分步说明。这种详细程度使文档更有用，并增加了采用率。

如果您仔细观察自己的组织，您可能会发现您内部已经有了这种类型的文档，只需将其外部化即可。在这里，您可以利用您的客户团队、营销团队、UI 团队和图形团队成员，向您的平民开发者宣传这种宝贵的资源。

“多媒体文档可以对消费和低代码开发人员从 API 中获得的好处产生巨大影响，”Kirwan 分享道。

如何通过高质量文档推动API的采纳？

如何选择最佳的集成机会来获得采纳？

Webflow、Bubble和Thunkable等低代码工具拥有大量受众和 API 连接器。当您围绕这些工具建立起一个忠实的用户社区时，低代码开发人员将开始构建在该平台上运行的插件，从而为产品的采用增加另一个入口点。

Kirwan 解释说，如果我们使用与之前相同的示例，那么为电动汽车充电器创建访问令牌应该既简单又直接。不要犹豫，看看现有的低代码工具。您可以搜索低代码应用程序开发并找到许多结果，但一定要选择一个具有易于集成机会的应用程序。集成越多，创建更多切入点和更粘性的用户就越好。

如何让API产品的自动化更简单？

低代码开发人员的另一个特点是，即使他们不是世界上最技术娴熟的人，他们也需要自动化所有可能的事情。通过预先提供可靠的文档，使他们能够即插即用并根据自己的意愿实现自动化，从而简化 API 产品的采用。成熟的文档还可以让其他开发人员专注于需要更多创新和创造力的事情。

如何提高API的可见性并创建一个API目录？

为了使采用更加可行，请盘点您的 API 之间的交互方式以及使用者，不仅是您的 API，还有您的 API 文档。正如我们上面所讨论的，好的文档是您的第一步，通过提供一组用例来使您的 API 变得有用，任何选择这些低代码工具之一的人都可以在学习该工具的同时将其作为示例项目来做，这将有所帮助。使用低代码或无代码工具的受众并不像理解每个细微差别的软件开发人员那样技术娴熟。

拥有 API 和文档后，请让它们可见，并找到提高可发现性的方法，以免忘记所有已拥有的内容。API目录是提高 API 程序和可用文档的可见性和可发现性的好方法。