With the rise in initiatives such as software ecosystems and Internet of Things (IoT), developing robust web Application Programming Interfaces (web APIs) has become an increasingly important practice. One main concern in developing web APIs is that they expose back-end systems and data toward clients. This exposure threatens critical non-functional requirements, such as the security of back-end systems, the performance of provided services, and the privacy of communications with clients. Although dealing with non-functional requirements during software design has been long studied, there is still little guide on addressing these requirements in web APIs. In this paper, we present WEBAPIK, a body of structured knowledge on addressing non-functional requirements in the design of web APIs. WEBAPIK is comprised of 27 distinct non-functional requirements, 37 distinct design techniques to address some of the identified requirements, and the trade-offs of 22 design techniques, presented in two forms of natural language and knowledge graphs. The design knowledge compiled in WEBAPIK is systematically extracted and aggregated from 80 heterogeneous online literature resources, including 7 books, 15 weblogs and tutorial, 5 vendor white papers, 6 design standards, and 47 research papers. These resources are systematically retrieved from two search engines of Google and Google Scholar and five research databases of Web of Science, IEEE Xplore, ACM Digital Library, SpringerLink, and ScienceDirect in two periods of March to August 2018 and August 2022. WEBAPIK gathers and structures expert and scholarly discussions to provide insight about addressing non-functional requirements in the design of web APIs. The structure brought to the design knowledge makes it amenable towards extension and creates the potential for employing it in the database of knowledge-based systems that aid software developers in design decision-making.

随着软件生态系统和物联网 (IoT) 等计划的兴起，开发强大的 Web 应用程序编程接口 (Web API) 已成为越来越重要的实践。开发 Web API 的一个主要问题是它们向客户端公开后端系统和数据。这种暴露威胁到关键的非功能性需求，例如后端系统的安全性、所提供服务的性能以及与客户通信的隐私。尽管在软件设计过程中处理非功能性需求已被长期研究，但在 Web API 中处理这些需求的指南仍然很少。在本文中，我们介绍了 WEBAPIK，这是一个关于解决 Web API 设计中的非功能性需求的结构化知识体系。WEBAPIK 包含 27 种不同的非功能性需求、37 种不同的设计技术来解决一些已确定的需求，以及 22 种设计技术的权衡，以自然语言和知识图的两种形式呈现。WEBAPIK 中编译的设计知识系统地从 80 种异构的在线文献资源中提取和聚合，包括 7 本书、15 个博客和教程、5 个供应商白皮书、6 个设计标准和 47 个研究论文。这些资源是在2018年3月至2018年8月和2022年8月的两个时间段，从Google和Google Scholar两个搜索引擎以及Web of Science、IEEE Xplore、ACM Digital Library、SpringerLink和ScienceDirect的五个研究数据库中系统检索的。WEBAPIK 收集并组织专家和学术讨论，以提供有关解决 Web API 设计中的非功能性需求的见解。设计知识的结构使其易于扩展，并创造了在基于知识的系统数据库中使用它的潜力，这些系统可以帮助软件开发人员进行设计决策。