Strategic API Analysis and Planning: APIS Technical Report
传统上,软件API(应用程序编程接口)一直从技术角度来看,作为一种手段,从功能调用分离的实现,并作为一种方式来定义软件功能的合同。API的技术优势已在许多研究中报道。来自行业的几份报告为API提供了有用的实际设计考虑因素,包括收集使用数据,货币化策略以及何时向外部方开放API的建议。虽然这些建议可能很有用,但重点仍然是API,只是没有考虑API在更广泛的组织中扮演的角色,或者它如何适应组织战略。我们的行业经验表明,需要更多关于组织环境中API设计和管理的挑战和最佳实践的信息。此外,很明显,API能够作为软件密集型公司战略业务计划的一部分发挥关键作用。在这份报告中,我们展示了我们与公司合作的结果,以构建一个框架,从多个角度综合和总结API战略,包括:战略API生命周期,生命周期阶段特征,生命周期用例和过渡点,API分层架构,BAPO,价值建模,生态系统映射与目标模型,API指标,目标模型与指标,以及API治理指南。我们的研究是在行业和学术界的合作下进行的。该框架是通过研讨会和与公司合作伙伴的讨论迭代开发的。我们展示了如何使用概念框架来推动API战略的发展,借鉴我们在实践中对几家公司的研究。
2019-11-01 cs.SE
(Why) Is My Prompt Getting Worse? Rethinking Regression Testing for Evolving LLM APIs
The Hong Kong University of Science and Technology(香港科技大学);Carnegie Mellon University(卡内基梅隆大学)
针对LLM API静默更新导致的性能回归问题,通过毒性检测案例研究,提出需重新审视回归测试,并指出因正确性概念、提示词脆弱性和非确定性需根本改变传统测试方法。
2024-02-06 cs.CL cs.SE
Why and How Java Developers Break APIs
现代软件开发依赖于API来重用代码并提高生产力。与大多数软件系统一样,这些库和框架也会发展,这可能会破坏现有的客户端。然而,在API中引入突破性变化的主要原因尚不清楚。因此,在本文中,我们报告了一个近4个月的长期实地研究的结果与400个流行的Java库和框架的开发人员。我们配置了一个基础设施来观察这些库中的所有更改,并在代码中引入这些更改后不久检测出破坏性更改。在确定了突破性的更改之后,我们要求开发人员解释他们决定更改API的原因。在研究过程中,我们确定了59个突破性的变化,并得到了19个项目开发人员的确认。通过分析开发人员的回答,我们报告说,突破性的变化主要是出于实现新功能的需要,希望使API更简单,元素更少,并提高可维护性。最后,我们提供建议,语言设计者,工具建设者,软件工程研究人员和API开发。
2018-01-16 cs.SE
Which RESTful API Design Rules Are Important and How Do They Improve Software Quality? A Delphi Study with Industry Experts
一些研究分析了现有的Web API对REST的约束,以估计最先进的API之间的REST合规程度。这些研究表明,只有少数Web API是真正的REST风格。此外,理论上的REST概念和实际实现之间的不匹配使我们相信,实践者在其重要性和对软件质量的影响方面对许多规则和最佳实践的看法与这些REST概念不同。因此,我们进行了一项Delphi研究,在这项研究中,我们向来自行业的八位Web API专家提出了82条REST API设计规则的目录。对于每个规则,我们让他们评估其重要性和软件质量影响。作为共识,我们的专家将28条规则评为高重要性,17条中等重要性,37条低重要性。此外,他们认为可用性、可维护性和兼容性是最受影响的质量属性。详细的分析显示,专家们认为达到Richardson成熟度等级2的规则是至关重要的,而达到等级3则不那么重要。由于所获得的共识数据可以作为设计工具支持的方法用于RESTful API的自动质量评估的有价值的输入,我们简要讨论了这种方法的要求,并评论了最重要的规则的适用性。
2021-07-30 cs.SE
Developer Perspectives on REST API Usability: A Study of REST API Guidelines
IT University of Copenhagen(哥本哈根IT大学);Ruhr University Bochum(波鸿鲁尔大学);viadee AG(viadee股份公司)
研究通过访谈16名REST API专家,探讨REST API指南的可用性、有效性因素及开发者对严格指南的抵触,提出遵循惯例是关键,需考虑指南大小与组织需求的匹配。
2026-01-23 cs.SE
Towards Human-Bot Collaborative Software Architecting with ChatGPT
Lancaster University Leipzig(兰卡斯特大学莱比锡校区);University of Jyväskylä(于韦斯屈莱大学);Wuhan University(武汉大学);University of Southern Queensland(南昆士兰大学)
构建软件密集型系统可能是一个复杂的过程。它处理统一涉众的观点、设计者的智慧、基于工具的自动化、模式驱动的重用等令人生畏的任务,以勾画出指导软件实现和评估的蓝图。尽管以架构为中心的软件工程(ACSE)有很多好处,但它也面临着许多挑战。ACSE挑战可能源于缺乏标准化流程、社会技术限制和缺乏人类专业知识等,这些都可能阻碍现有和新兴软件类别的开发(例如,物联网、区块链、量子系统)。在大语言模型上训练的软件开发机器人(DevBots)可以帮助协同架构师的知识与人工智能决策支持,以实现人机协作ACSE中的快速架构。ChatGPT是一种支持这种协作的新兴解决方案,这是一种颠覆性技术,主要不是为软件工程引入的,而是能够基于自然语言处理阐明和细化架构工件。我们详细介绍了一个案例研究,涉及一个新手软件架构师和ChatGPT的架构分析,合成和评估服务驱动的软件应用程序之间的合作。初步结果表明,ChatGPT可以模仿架构师的角色,以支持并经常领导ACSE,但是,它需要人为的监督和决策支持的协作架构。未来的研究重点是利用关于建筑师生产力的经验证据,并利用ChatGPT探索建筑的社会技术方面,以应对ACSE的新兴和未来挑战。
2023-02-26 cs.AI cs.SE
Octopus: On-device language model for function calling of software APIs
Stanford University(斯坦福大学);Harvard University(哈佛大学)
研究利用设备端大语言模型调用软件API,通过编译数据集微调不同参数模型,提升其API交互能力,提出条件掩码技术和新基准,经微调的Octopus模型在API调用上性能超GPT-4,推动自动化软件开发和API集成。
2026-07-21 cs.CL cs.SE
Enhancing REST API Fuzzing with Access Policy Violation Checks and Injection Attacks
Erciyes University(埃尔齐耶斯大学);Kristiania University College(克里斯蒂亚尼亚大学学院);Beihang University(北京航空航天大学);Oslo Metropolitan University(奥斯陆都市大学)
本文提出新型自动化或acles检测REST API访问策略违规及传统攻击,集成EvoMaster fuzzers,通过模糊测试发现安全问题。
2026-04-01 cs.CR cs.SE
Bootstrapping Cookbooks for APIs from Crowd Knowledge on Stack Overflow
成熟的库通常都有API文档。然而,它们经常缺乏示例和解释,可能难以有效地重用它们。Stack Overflow是一个面向软件开发相关问题的问答网站。尽管越来越多地采用堆栈溢出,但与特定主题相关的信息(例如,API)分布在整个网站上。因此,Stack Overflow仍然缺乏对现有群众知识的组织。我们的目标是通过提供一个替代工件来解决API文档质量差的问题,该工件基于Stack Overflow上可用的群众知识来记录API,称为群众食谱。烹饪书是一本以食谱为导向的书,我们将我们的烹饪书称为人群烹饪书,因为它包含了人群生成的内容。烹饪书的目的是通过探索过程来使用,即浏览。在本文中,我们提出了一种半自动的方法,该方法组织了Stack Overflow上可用的人群知识,以构建API的食谱。我们已经为软件开发社区广泛使用的三种API生成了食谱:SWT,LINQ和QT。我们还定义了人群食谱必须满足的期望属性,并且我们对人类受试者的食谱进行了评估。结果表明,使用我们的方法构建的食谱,一般来说,满足这些属性。作为一个亮点,大多数食谱被认为是适当的,在食谱和有自我包含的信息。我们的结论是,我们的方法是能够自动生成足够的食谱,这可以是手动制作的食谱一样有用。这为API设计者提供了一个机会,可以用来自人群的不同观点来丰富现有的食谱,甚至可以生成新食谱的初始版本。
2019-03-21 cs.SE
EMF-REST: Generation of RESTful APIs from Models
本文提出 EMF-REST 方法,利用模型驱动工程技术从 EMF 数据模型自动生成遵循 REST 原则的 Web API,并集成模型验证与安全能力,提升 Web 开发敏捷性并为 MDE 实践者提供云建模基础。
2015-04-14 cs.SE
The Collective Knowledge project: making ML models more portable and reproducible with open APIs, reusable best practices and MLOps
cTuning foundation(cTuning基金会);cKnowledge SAS(cKnowledge SAS公司)
本文概述了集体知识技术(CK或cKnowledge)。CK试图让机器学习和系统研究更容易重现,在生产中部署机器学习模型,并使其适应不断变化的数据集、模型、研究技术、软件和硬件。CK的概念是将复杂的系统和特别的研究项目分解为具有统一API、CLI和JSON Meta描述的可重用子组件。这些组件可以使用DevOps原则与可重用的自动化操作、软件检测插件、Meta包和公开的优化参数相结合连接到可移植的工作流中。CK工作流可以自动插件来自不同供应商的不同模型、数据和工具,同时在不同的平台和环境中以统一的方式构建、运行和基准测试研究代码。这样的工作流程还有助于执行整个系统优化,重现结果,并使用CK平台上的公共或私人记分牌(https://www.example.com)进行比较。cKnowledge.io例如,模块化CK方法已与工业合作伙伴成功验证,可自动协同设计和优化软件、硬件和机器学习模型,以实现速度、准确性、能量、尺寸和其他特性方面的可再现和高效目标检测。长期目标是通过帮助研究人员和从业者使用开放的CK API共享和重用他们的知识、经验、最佳实践、工件和技术,简化和加速ML模型和系统的开发和部署。
2020-06-18 cs.LG cs.SE stat.ML
Don't forget your classics: Systematizing 45 years of Ancestry for Security API Usability Recommendations
开发安全的软件是一项挑战。安全API的可用性差使得这更加困难。已经提出了许多建议,通过提高密码库和API的可用性来支持开发人员;植根于软件工程和API设计中更广泛的最佳实践指南。在本SLR中,我们系统化了有关这些建议的知识。我们识别并分析了45年来的65篇论文,共提供了883条建议。我们进行了主题分析,以确定提高API可用性的7种核心方法。我们发现,大多数建议侧重于帮助API开发人员构建和结构化他们的代码,使其更易于使用,更容易为程序员理解。然而,对文档、编写要求、代码质量评估和组织软件开发实践的影响的关注较少。通过追踪和分析论文来源,我们绘制了这些知识如何随着时间的推移而得到验证和转化。我们发现,只有不到四分之一的API可用性建议得到了经验验证,而针对可用安全API的建议在这方面甚至更落后。
2021-05-05 cs.CR cs.SE
Detecting Misuse of Security APIs: A Systematic Review
本文通过系统性文献综述分析69篇论文,梳理安全API的类型、误用形式、检测技术、性能度量与评估基准,并指出研究空白与未来方向。
2025-05-14 cs.CR cs.SE
Are Human Rules Necessary? Generating Reusable APIs with CoT Reasoning and In-Context Learning
本文提出 Code2API,利用思维链推理和少样本上下文学习自动将 Stack Overflow 代码片段转化为可复用 API,无需训练或人工规则,在参数与返回值识别上显著超越 APIzator,并验证了跨语言泛化能力。
2024-05-06 cs.SE
The Case for API Communicability Evaluation: Introducing API-SI with Examples from Keras
除了在专业软件开发中的重要作用外,应用程序编程接口(API)现在越来越多地被非专业程序员使用,包括最终用户,科学家和其他领域的专家。因此,好的API必须满足新老用户的需求。大多数关于API评估和设计的研究都源于以用户为中心的人机交互认知视角。作为一种替代方案,我们提出了一个较低的阈值的变化,以前提出的符号API评估工具。我们使用Keras(一种深度学习API)说明了这个变体(称为API含义检查(API-SI))的程序和功能。该图还显示了该方法如何补充和丰富API可用性研究。此外,API-SI被打包为一个介绍性的符号学工具,API设计人员和研究人员可以使用它来评估设计意图和产品原理与其他程序员的沟通,通过在API结构,行为和文档中遇到的隐式和显式符号。
2018-08-17 cs.SE
A Wizard of Oz Study Simulating API Usage Dialogues with a Virtual Assistant
虚拟助手技术正在迅速普及,以提高各种任务的生产力。虽然用于日常任务的几个虚拟助理是众所周知的(例如,Siri、Cortana、Alexa),从事软件工程等专业任务的助理则更为罕见。软件工程助理很少的一个关键原因是,很少有实验数据集可用于训练人工智能,而人工智能是当前虚拟助理的基础。在本文中,我们提出了一组绿野仙踪实验,我们设计来构建一个数据集,用于创建一个虚拟助手。我们的目标是一个虚拟助手,帮助程序员使用API。在我们的实验中,我们招募了30名专业程序员,使用两个API完成编程任务。程序员与一个模拟的虚拟助手进行交互以寻求帮助-程序员并不知道助手实际上是由人类专家操作的。然后,我们注释语料库中的对话行为沿着四个维度:言外之意,API信息类型(S),面向后的功能,和特定的API组件的可追溯性。我们观察到了各种各样的交互,这将有助于为API使用的虚拟助手开发对话策略。
2021-06-23 cs.HC cs.SE
Learning GraphQL Query Costs (Extended Version)
Rensselaer Polytechnic Institute(伦斯勒理工学院);Inria Paris, École normale supérieure – PSL university(巴黎Inria,巴黎高等师范学校–PSL大学);IBM Research(IBM研究院)
GraphQL是一种用于API的查询语言和用于执行这些查询的运行时,从现有的微服务,REST API,数据库或其他来源获取所请求的数据。它的表现力和灵活性使其成为许多行业的API提供商的有吸引力的候选者,特别是通过Web。在GraphQL中盲目服务客户端查询的一个主要缺点是,查询的成本可能会出乎意料地大,为提供者带来计算和资源过载,为客户端带来API速率限制和基础设施过载。为了减轻这些缺点,有必要在执行查询之前有效地估计查询的成本。估计查询成本具有挑战性,因为GraphQL查询具有嵌套结构,GraphQL API遵循不同的设计约定,并且底层数据源是隐藏的。基于最坏情况静态查询分析的估计成功有限,因为它们往往严重高估了成本。我们提出了一种机器学习的方法来有效和准确地估计查询成本。我们还展示了这种方法的力量,通过测试它的查询响应数据从公开的商业API。我们的框架是有效的,预测查询成本具有很高的准确性,始终优于静态分析的大幅度。
2021-08-26 cs.DB cs.LG cs.PL
Linking Stakeholders' Viewpoint Concerns and Microservices-based Architecture
敏捷项目管理的广泛采用,微服务的独立交付以及DevOps的自动化部署极大地加快了系统开发。真正改变游戏规则的是持续集成(CI)、持续交付和持续部署(CD)。组织可以一天发布多个版本,将测试、发布和部署周期从数周缩短到数分钟。Docker等容器技术和Kubernetes等容器编排平台的成熟促进了微服务架构的发展,特别是在云原生开发中。有各种工具可用于设置CI/CD管道。组织正在远离单体应用程序,转向基于微服务的架构。组织可以通过应用程序编程接口(API)快速积累数百个此类微服务。这些现代方法的主要目的是敏捷性、速度和可重用性。虽然DevOps提供了速度和上市时间,但除非微服务和API与企业范围的利益相关者的需求相关联,否则敏捷性和可重用性可能无法得到保证。业务需求和微服务/API之间的联系没有得到很好的捕捉,也没有得到充分的定义。在本出版物中,我们描述了一种结构化方法,用于在API和基于微服务的敏捷开发之间创建逻辑链接,并考虑企业利益相关者的需求和观点。这种方法能够捕获和记录企业范围内利益相关者的需求,无论这些利益相关者是企业所有者、规划者(产品所有者、架构师)、设计者(开发人员、DevOps工程师)还是企业的合作伙伴和订阅者。
2020-09-13 cs.SE
Automating a Complete Software Test Process Using LLMs: An Automotive Case Study
Chalmers University of Technology(查尔姆斯理工大学);Volvo Group(沃尔沃集团)
本文针对车载 API 测试中规范不一致、歧义和相互依赖等复杂问题,提出一种基于大语言模型的分段式自动化测试系统,并在超过 100 个 API 上验证了其有效性和完全自动化潜力。
2025-02-06 cs.AI cs.SE
Accelerating News Integration in Automatic Knowledge Extraction Ecosystems: an API-first Outlook
利用应用程序编程接口(API)已被广泛认为是软件和系统设计的一种有价值的方法,通过允许将接口设计与服务实现细节分离,促进了产品和服务开发的加速。新闻和新闻业的许多组织都采用并推广了这种面向API的方法。在本文的第一部分,我们提供了一个调查的最重要的最近的工作围绕传统的新闻和新闻开放的API,以及这些如何受到影响,并影响了新闻产品景观。在本文的第二部分,我们确定了两个颠覆性的技术趋势,我们认为这将影响未来新闻/新闻产品的作用和价值:API优先的开发方法,以及新闻支持的自动知识提取和分析服务的作用。我们预计,这两个驱动力将在知识平台的新闻内容采用方面创造新的采用、开放协作、标准化和整体进步浪潮。我们简要介绍一下我们在道琼斯这方面的经验。
2015-09-19 cs.CY cs.SE
Answering Uncertain, Under-Specified API Queries Assisted by Knowledge-Aware Human-AI Dialogue
本文提出知识感知人机对话代理 KAHAID,通过多轮问答澄清不确定的 API 查询,提供可解释和可扩展的推荐,显著提升推荐效果与用户启发。
2023-04-27 cs.SE
APICom: Automatic API Completion via Prompt Learning and Adversarial Training-based Data Augmentation
针对API推荐任务,提出基于提示学习和对抗训练数据增强的自动API补全方法APICom,利用API前缀信息生成查询相关API,在多项指标上显著优于基线。
2023-09-13 cs.SE
Let's Chat to Find the APIs: Connecting Human, LLM and Knowledge Graph through AI Chain
本文提出由知识图谱引导的五阶段 LLM AI 链,用于 API 推荐中的多轮查询澄清,实验证明其在 MRR、MAP 及问题质量上显著优于基线。
2023-09-28 cs.SE
Benchmarking Web API Integration Code Generation
Hessian Center for Artificial Intelligence(黑森人工智能中心);National Research Center for Applied Cybersecurity ATHENE(应用网络安全国家研究研究中心ATHENE);Pariton AI
本文提出WAPIIBench数据集和评估流程,评估LLM生成Web API调用代码的能力,发现现有开源模型在生成API调用时存在显著挑战,如错误端点和参数使用问题。
2026-07-03 cs.LG cs.SE
PromptDebt: A Comprehensive Study of Technical Debt Across LLM Projects
University of North Texas(北德克萨斯大学)
本文首次大规模实证研究LLM项目中的自我承认技术债务,分析93,142个Python文件,发现OpenAI集成和提示设计是主要债务来源,并发布数据集以支持可复现性。
2025-09-24 cs.SE