API 接口

应用程序通过人为预设的规则和协议，使得系统之间能够进行数据通讯与数据交换。

文档化

API 文档包含有关 API 可用端点、方法、资源、身份验证协议、参数和标头的详细信息，以及常见请求和响应的示例

• 有效的 API 文档可改善跨团队协作

• API 文档可让决策层更轻松地了解第三方 API 的预期用例并确定它是否有助于推进其组织的业务目标

• 优先考虑 API 文档的团队通常会看到更高的 API 使用率、更少的支持工单，并且部分会导致收入增加

优势

• 撰写内部文档的短期收益远低于这件事能够带来的成本。因为使用传统方式撰写接口文档是一件繁琐复杂的事情，需要在各个工具进行切换，最终才能写出一份接口文档

• 有些开发人员可能只关注技术实现细节，对于如何提高项目的可维护性和可扩展性等方面的问题缺乏深入的思考，导致写文档的兴趣和动力不足，输出的文档质量也无法具备良好的可读性

API 文档化的挑战

7大核心发现

APIs are a moneymaker for most

近三分之二的受访者表示他们的 API 会产生收入。

在这些受访者中，43% 的人表示 API 创造了公司收入的四分之一以上。

在金融服务和广告领域，API 收入受到密切衡量。

它被评为衡量公共 API 成功与否的第二重要指标，仅次于使用率。

API pricing increasingly matters

在决定是否与 API 集成时，47% 的受访者表示价格是一个考虑因素。

这比前两年每年的 41% 有所上升。

虽然其他因素的排名高于定价，但这一发现可能反映了在科技经济收缩后，API 消费者更加注重成本。

The outlook for API investments has brightened

92% 的全球受访者表示，未来 12 个月内 API 投资将增加或保持不变，高于去年的 89%。

这一增长可能反映出某些方面认为科技行业经济收缩最糟糕的时期已经过去。

与此同时，表示预计今年将削减 API 投资的受访者较少。

Most API professionals are using AI to help code

60% 的 API 专业人员表示他们在工作中使用生成式人工智能。

其中超过一半使用人工智能工具来查找代码中的错误，超过三分之一的人依靠人工智能来生成计算机可以理解的代码。

当被问及来年哪种类型的项目最让开发者兴奋时，最重要的答案是构建人工智能驱动的应用程序，超过三分之一的受访者选择了这一点。

Number of API-first leaders swells by almost half

今年，11% 的受访者将自己定义为 API 优先领导者，高于前两年每年的 8%。

这个精英群体几乎在每一个指标上都表现出色。

例如，API 优先的领导者可以更快地生产 API，并报告更少的故障。

当 API 发生故障时，大多数 API 优先的领导者可以在不到一个小时的时间内恢复它——只有少数受访者可以达到这一壮举。

When API developers exit, they leave a big hole

2023 年，软件工程师经历了迄今为止最大的技术裁员。

他们的缺席对公司意味着什么？我们的研究结果表明，当开发人员退出时，API 组织混乱且文档记录不完善的公司可能会发现意想不到的问题。

调查者表示，最令人担忧的是过时的文档、僵尸 API 和机构记忆的丧失。

API security is improving, but some sectors have work to do

大多数受访者的 API 安全性有所改善，事件频率在 2023 年有所下降。

但某些行业的表现比其他行业更差。

调查者表示，汽车、教育和零售行业的每月事故发生率高于平均水平。

more:

• https://www.postman.com/state-of-api/who-works-with-apis/#who-works-with-apis

• https://www.postman.com/explore

– sddtc

Thanks!