With the increasing adoption of services-oriented computing and cloud computing technologies, web APIs have become the fundamental building blocks for constructing software applications. Web APIs are developed and published on the internet. The functionality of web APIs can be used to facilitate the development of software applications. There are numerous studies on retrieving and recommending candidate web APIs based on user requirements from a large set of web APIs. However, there are very limited studies on the features of web APIs that make them more likely to be used and the issues of using web APIs in practice. Moreover, users’ expectations on the development and management of web APIs are rarely investigated. In this paper, we conduct a large-scale empirical study of 20,047 web APIs published at two popular and publicly accessible web API registries: ProgrammableWeb and APIs.guru. We first extract the questions posted in Stack Overflow (SO) that are relevant to the web APIs. We then manually analyze 1,885 randomly sampled SO questions and identify 24 web API issue types (e.g., authorization error) that are encountered by users. Afterwards, we conduct a user survey to investigate the features of web APIs that users often consider when shortlisting a web API for testing before they adopt it, validate the identified types of web API issues, and understand users’ expectations on the development and management of web APIs. From the 191 received responses, we extract 14 important features for users to decide whether to use a web API (e.g., well-organized documentation). We also gain a better understanding of web API issue types and summarize 11 categories of user expectations on web APIs (e.g., documentation and SDK/library). As the result of our study, we provide guidelines for web API developers and registry managers to improve web APIs and promote the use of web APIs.

中文翻译：

---

Web API：特征、问题和期望 — 使用 Stack Overflow 和用户调查对来自两个可公开访问的注册中心的 Web API 进行大规模实证研究


随着面向服务的计算和云计算技术的日益普及，Web API 已成为构建软件应用程序的基本构建块。 Web API 是在互联网上开发和发布的。 Web API 的功能可用于促进软件应用程序的开发。有大量关于根据用户需求从大量 Web API 中检索和推荐候选 Web API 的研究。然而，对于 Web API 的哪些特性使其更容易被使用以及在实践中使用 Web API 的问题的研究非常有限。此外，用户对Web API的开发和管理的期望也很少被调查。在本文中，我们对两个流行且可公开访问的 Web API 注册中心（ProgrammableWeb 和 APIs.guru）发布的 20,047 个 Web API 进行了大规模实证研究。我们首先提取 Stack Overflow (SO) 中发布的与 Web API 相关的问题。然后，我们手动分析 1,885 个随机抽样的 SO 问题，并识别用户遇到的 24 个 Web API 问题类型（例如授权错误）。然后，我们进行用户调查，调查用户在采用 Web API 之前筛选 Web API 进行测试时经常考虑的 Web API 特性，验证已识别的 Web API 问题类型，并了解用户对 Web API 开发和管理的期望。网络 API。从收到的 191 条回复中，我们提取了 14 个重要特征，供用户决定是否使用 Web API（例如，组织良好的文档）。我们还更好地了解了 Web API 问题类型，并总结了 11 类用户对 Web API 的期望（例如文档和 SDK/库）。 根据我们的研究结果，我们为 Web API 开发人员和注册管理人员提供了改进 Web API 并促进 Web API 的使用的指南。