| 摘要: |
| API （application programming interface，应用程序编程接口）在现代软件开发过程中被广泛使用.开发人员通过调用API快速构建项目，节省了大量的时间.但由于API数量众多、文档不够完善、维护更新不及时等原因，开发人员在学习使用API的过程中面临着严峻的挑战.一旦API使用不正确，程序可能会出现缺陷甚至严重的安全问题.通过对API相关文献的深入调研，对近些年来国内外学者在该研究领域取得的成果进行了系统总结.首先，介绍了API的基本概念并分析出影响API使用的3个关键问题：API文档质量不高、调用规约不完整以及API调用序列难以确定；接着，从API文档、调用规约和API推荐这3个主要方面对研究成果进行全面的分析；最后，对未来研究可能面临的挑战进行了展望. |
| 关键词: API 调用规约 API文档 API推荐 API使用 |
| DOI：10.13328/j.cnki.jos.005541 |
| 分类号: |
| 基金项目:国家科技重大专项（2014ZX01029101-002）；国家自然科学基金（61772507） |
|
| Study on Key Issues in API Usage |
|
LI Zheng1,2, WU Jing-Zheng1, LI Ming-Shu1
|
|
1.Institute of Software, The Chinese Academy of Sciences, Beijing 100190, China;2.University of Chinese Academy of Sciences, Beijing 100190, China
|
| Abstract: |
| API (application programming interface) is widely used in modern software development process. Developers save a lot of time when they quickly build projects through invoking APIs. However, API is often difficult to use for many reasons, such as the presence of large number of interfaces, lack of perfect document, and no timely maintenance and updates. Further, API is often used incorrectly, resulting in bugs and sometimes significant security problems.This paper summarizes the recent domestic and overseas research results based on a thorough survey of the API related literatures. Firstly, it introduces the API concept and recognizes the three key issues that affect the API usage:poor API documentation, incomplete invocation specification and undetermined API call sequence. Next, it analyzes the latest advances from these three main aspects:API document, invocation specification and API recommendation. Finally, this paper outlines the challenges of the future research. |
| Key words: API invocation specification API documentation API recommendation API usage |
