An Exploratory Study of API Usage Examples on the Web

被引:2
|
作者
Wang, Lijie [1 ]
Zou, Yanzhen
Fang, Lu
Xie, Bing
Yang, Fuqing
机构
[1] Peking Univ, Sch Elect Engn & Comp Sci, Software Inst, Beijing 100871, Peoples R China
基金
中国国家自然科学基金;
关键词
empirical study; API; usage examples; web search;
D O I
10.1109/APSEC.2012.122
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
Usage examples are helpful for programmers learning to use APIs from third-party frameworks or libraries. There are lots of usage examples scattered in web pages on the Web, such as tutorials, blogs, and forums. A few researches have proposed approaches to leveraging these usage examples to improve programming. However, due to the lack of comprehensive understanding on the current situation of usage examples on the web, the work is still at the very beginning. Many concerns are reserved, for instance, how many usage examples can be found on the Web? how well do such examples support programmers on earth? what factors have impact on these examples' usability? In this paper, we conducted an exploratory study of usage examples on the web, including their distribution, characteristics like content style, correctness, and complexity, as well as their correlations. Through the study, we obtain some insight of how to facilitate utilization of usage examples on the web and what mechanisms could be provided. Possible research directions and problems are proposed at the end.
引用
收藏
页码:396 / 405
页数:10
相关论文
共 50 条
  • [21] Mica: A web-search tool for finding API components and examples
    Stylos, Jeffrey
    Myers, Brad A.
    IEEE SYMPOSIUM ON VISUAL LANGUAGES AND HUMAN-CENTRIC COMPUTING, PROCEEDINGS, 2006, : 195 - +
  • [22] API Deprecation: A retrospective analysis and detection method for code examples on the web
    Laboratory for Software Modification Research, Department of Computer Science, University of Calgary, Calgary, Canada
    Proc ACM SIGSOFT Symp Found Software Eng, (266-277):
  • [23] Challenges of API Documentation from a Provider Perspective and Best Practices for Examples in Public Web API Documentation
    Bondel, Gloria
    Cerit, Arif
    Matthes, Florian
    ICEIS: PROCEEDINGS OF THE 24TH INTERNATIONAL CONFERENCE ON ENTERPRISE INFORMATION SYSTEMS - VOL 2, 2022, : 268 - 279
  • [24] PatternLens: Inferring evolutive patterns from web API usage logs
    Koci, Rediana
    Franch, Xavier
    Jovanovic, Petar
    Abello, Alberto
    INTELLIGENT INFORMATION SYSTEMS, CAISE FORUM 2021, 2021, 424 : 146 - 153
  • [25] An Observational Study on API Usage Constraints and Their Documentation
    Saied, Mohamed Aymen
    Sahraoui, Houari
    Dufour, Bruno
    2015 22ND INTERNATIONAL CONFERENCE ON SOFTWARE ANALYSIS, EVOLUTION, AND REENGINEERING (SANER), 2015, : 33 - 42
  • [26] A Case Study of Web API Evolution
    Sohan, S. M.
    Anslow, Craig
    Maurer, Frank
    2015 IEEE WORLD CONGRESS ON SERVICES, 2015, : 245 - 252
  • [27] Task-Oriented API Usage Examples Prompting Powered By Programming Task Knowledge Graph
    Sun, Jiamou
    Xing, Zhenchang
    Peng, Xin
    Xu, Xiwei
    Zhu, Liming
    2021 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE AND EVOLUTION (ICSME 2021), 2021, : 448 - 459
  • [28] A Dataset For API Usage
    Sawant, Anand Ashok
    Bacchelli, Alberto
    12TH WORKING CONFERENCE ON MINING SOFTWARE REPOSITORIES (MSR 2015), 2015, : 506 - 509
  • [29] An Observational Study on Compatibility-Related API Usage
    Xu, Chen
    Xiong, Yan
    Huang, Wenchao
    Meng, Zhaoyi
    5TH INTERNATIONAL CONFERENCE ON BIG DATA COMPUTING AND COMMUNICATIONS (BIGCOM 2019), 2019, : 64 - 68
  • [30] Enhancing API Labelling with BERT and GPT: An Exploratory Study
    Morais, Gabriel
    Lemelin, Edwin
    Adda, Mehdi
    Bork, Dominik
    ENTERPRISE DESIGN, OPERATIONS, AND COMPUTING. EDOC 2024 WORKSHOPS, 2025, 537 : 169 - 182