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 条
  • [1] Inappropriate Usage Examples in Web API Documentations
    Hosono, Masaki
    Washizaki, Hironori
    Honda, Kiyoshi
    Nagumo, Hiromasa
    Sonoda, Hisanobu
    Fukazawa, Yoshiaki
    Munakata, Kazuki
    Nakagawa, Takao
    Nemoto, Yusuke
    Tokumoto, Susumu
    Monpratarnchai, Supasit
    2019 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE AND EVOLUTION (ICSME 2019), 2019, : 343 - 347
  • [2] Synthesizing API Usage Examples
    Buse, Raymond P. L.
    Weimer, Westley
    2012 34TH INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING (ICSE), 2012, : 782 - 792
  • [3] A Study of the Effectiveness of Usage Examples in REST API Documentation
    Sohan, S. M.
    Maurer, Frank
    Anslow, Craig
    Robillard, Martin P.
    2017 IEEE SYMPOSIUM ON VISUAL LANGUAGES AND HUMAN-CENTRIC COMPUTING (VL/HCC), 2017, : 53 - 61
  • [4] Synthesising Linear API Usage Examples for API Documentation
    Alharbi, Seham
    Kolovos, Dimitris
    Matragkas, Nicholas
    2022 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE AND EVOLUTION (ICSME 2022), 2022, : 607 - 611
  • [5] Unit Tests as API Usage Examples
    Nasehi, Seyed Mehdi
    Maurer, Frank
    2010 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE, 2010,
  • [6] APISonar: Mining API usage examples
    Hora, Andre
    SOFTWARE-PRACTICE & EXPERIENCE, 2021, 51 (02): : 319 - 352
  • [7] Visualizing API Usage Examples at Scale
    Glassman, Elena L.
    Zhang, Tianyi
    Hartmann, Bjoern
    Kim, Miryung
    PROCEEDINGS OF THE 2018 CHI CONFERENCE ON HUMAN FACTORS IN COMPUTING SYSTEMS (CHI 2018), 2018,
  • [8] Improving Web API Usage Logging
    Koci, Rediana
    Franch, Xavier
    Jovanovic, Petar
    Abello, Alberto
    RESEARCH CHALLENGES IN INFORMATION SCIENCE (RCIS 2021), 2021, 415 : 623 - 629
  • [9] Mining API Usage Examples from Test Code
    Zhu, Zixiao
    Zou, Yanzhen
    Xie, Bing
    Jin, Yong
    Lin, Zeqi
    Zhang, Lu
    2014 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE AND EVOLUTION (ICSME), 2014, : 301 - 310
  • [10] Generating an Interactive View of Dynamic Aspects of API Usage Examples
    Ishida, Yoshiya
    Arimatsu, Yuu
    Kaixie, Lyu
    Takagi, Go
    Noda, Kunihiro
    Kobayashi, Takashi
    2018 IEEE THIRD INTERNATIONAL WORKSHOP ON DYNAMIC SOFTWARE DOCUMENTATION (DYSDOC3), 2018, : 13 - 14