demonstration

API Caveat Explorer -- Surfacing Negative Usages from Practice: An API-oriented Interactive Exploratory Search System for Programmers

Authors:

Jing Li,

Aixin Sun,

Zhenchang Xing,

Lei HanAuthors Info & Claims

SIGIR '18: The 41st International ACM SIGIR Conference on Research & Development in Information Retrieval

Pages 1293 - 1296

https://doi.org/10.1145/3209978.3210170

Published: 27 June 2018 Publication History

Get Access

Abstract

Application programming interface (API) documentation well describes an API and how to use it. However, official documentation does not describe "how not to use it" or the different kinds of errors when an API is used wrongly. Programming caveats are negative usages of an API. When these caveats are overlooked, errors may emerge, leading to heavy discussions on Q&A websites like Stack Overflow. In this demonstration, we present API Caveat Explorer, a search system to explore API caveats that are mined from large-scale unstructured discussions on Stack Overflow. API Caveat Explorer takes API-oriented queries such as "HashMap" and retrieves API caveats by text summarization techniques. API caveats are represented by sentences, which are context-independent, prominent, semantically diverse and non-redundant. The system provides a web-based interface that allows users to interactively explore the full picture of all discovered caveats of an API, and the details of each. The potential users of API Caveat Explorer are programmers and educators for learning and teaching APIs.

References

[1]

D. M Blei, A. Y Ng, and M. I Jordan. 2003. Latent dirichlet allocation. JMLR 3 (2003), 993--1022.

Digital Library

Google Scholar

[2]

V. D Blondel, J.-L. Guillaume, R. Lambiotte, and E. Lefebvre. 2008. Fast unfolding of communities in large networks. Journal of statistical mechanics: theory and experiment 2008, 10 (2008), P10008.

Crossref

Google Scholar

[3]

B. Dagenais and M. P Robillard. 2012. Recovering traceability links between an API and its learning resources. In ICSE. 47--57.

Digital Library

Google Scholar

[4]

G. Erkan and D. R Radev. 2004. Lexrank: Graph-based lexical centrality as salience in text summarization. JAIR 22 (2004), 457--479.

Digital Library

Google Scholar

[5]

J. Goldstein, M. Kantrowitz, V. Mittal, and J. Carbonell. 1999. Summarizing text documents: sentence selection and evaluation metrics. In SIGIR. 121--128.

Digital Library

Google Scholar

[6]

J. Li, A. Sun, and Z. Xing. 2018. Learning to answer programming questions with software documentation through social context embedding. Information Sciences 448 (2018), 36--52.

Crossref

Google Scholar

[7]

C.-Y. Lin. 2004. Rouge: A package for automatic evaluation of summaries. In Proc. ACL-04 workshop, Vol. 8.

Digital Library

Google Scholar

[8]

J. MacQueen. 1967. Some methods for classification and analysis of multivariate observations. In Proc. Berkeley symposium on mathematical statistics and probability, Vol. 1. 281--297.

Google Scholar

[9]

S. Subramanian, L. Inozemtseva, and R. Holmes. 2014. Live API documentation. In ICSE. 643--652.

Digital Library

Google Scholar

Cited By

View all

Liang QJin YXie QKuang LSheng Y(2024)JARAD: An Approach for Java API Mention Recognition and Disambiguation in Stack OverflowCollaborative Computing: Networking, Applications and Worksharing10.1007/978-3-031-54521-4_15(265-283)Online publication date: 23-Feb-2024
https://doi.org/10.1007/978-3-031-54521-4_15
Han LChen TDemartini GIndulska MSadiq S(2023)A Data-Driven Analysis of Behaviors in Data Curation ProcessesACM Transactions on Information Systems10.1145/356741941:3(1-35)Online publication date: 7-Feb-2023
https://dl.acm.org/doi/10.1145/3567419
Huo YSu YZhang HLyu MDwyer MDamian DZeller A(2022)ARCLINProceedings of the 44th International Conference on Software Engineering10.1145/3510003.3510158(138-149)Online publication date: 21-May-2022
https://dl.acm.org/doi/10.1145/3510003.3510158
Show More Cited By

Index Terms

API Caveat Explorer -- Surfacing Negative Usages from Practice: An API-oriented Interactive Exploratory Search System for Programmers
1. Information systems
  1. Information retrieval
    1. Users and interactive retrieval

Recommendations

Exploring API embedding for API usages and applications
ICSE '17: Proceedings of the 39th International Conference on Software Engineering

Word2Vec is a class of neural network models that as being trained from a large corpus of texts, they can produce for each unique word a corresponding vector in a continuous space in which linguistic contexts of words can be observed. In this work, we ...
On Deprecated API Usages: An Exploratory Study of Top-Starred Projects on GitHub
Product-Focused Software Process Improvement
Abstract
A deprecated Application Programming Interface (API) is one that is no longer recommended to use by its original developers. While deprecated APIs (i.e., deprecated fields, methods, and classes) are still implemented, they can be removed in future ...
Visual Cafe for Java Explorer: Database Development Edition

Comments

Information & Contributors

Information

Published In

SIGIR '18: The 41st International ACM SIGIR Conference on Research & Development in Information Retrieval

June 2018

1509 pages

ISBN:9781450356572

DOI:10.1145/3209978

General Chairs:
Kevyn Collins-Thompson
University of Michigan, United States
,
Qiaozhu Mei
University of Michigan, United States
,
Program Chairs:
Brian Davison
Lehigh University, United States
,
Yiqun Liu
Tsinghua University, China
,
Emine Yilmaz
University College London, United Kingdom

Permission to make digital or hard copies of part or all of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for third-party components of this work must be honored. For all other uses, contact the Owner/Author.

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 27 June 2018

Check for updates

Author Tags

Qualifiers

Demonstration

Conference

SIGIR '18

Sponsor:

SIGIR

SIGIR '18: The 41st International ACM SIGIR conference on research and development in Information Retrieval

July 8 - 12, 2018

MI, Ann Arbor, USA

Acceptance Rates

SIGIR '18 Paper Acceptance Rate 86 of 409 submissions, 21%;

Overall Acceptance Rate 792 of 3,983 submissions, 20%

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

9
Total Citations
View Citations
203
Total Downloads

Downloads (Last 12 months)6
Downloads (Last 6 weeks)0

Reflects downloads up to 25 Jan 2025

Other Metrics

View Author Metrics

Citations

Cited By

View all

Liang QJin YXie QKuang LSheng Y(2024)JARAD: An Approach for Java API Mention Recognition and Disambiguation in Stack OverflowCollaborative Computing: Networking, Applications and Worksharing10.1007/978-3-031-54521-4_15(265-283)Online publication date: 23-Feb-2024
https://doi.org/10.1007/978-3-031-54521-4_15
Han LChen TDemartini GIndulska MSadiq S(2023)A Data-Driven Analysis of Behaviors in Data Curation ProcessesACM Transactions on Information Systems10.1145/356741941:3(1-35)Online publication date: 7-Feb-2023
https://dl.acm.org/doi/10.1145/3567419
Huo YSu YZhang HLyu MDwyer MDamian DZeller A(2022)ARCLINProceedings of the 44th International Conference on Software Engineering10.1145/3510003.3510158(138-149)Online publication date: 21-May-2022
https://dl.acm.org/doi/10.1145/3510003.3510158
Eberhart ZMcMillan C(2022)Generating Clarifying Questions for Query Refinement in Source Code Search2022 IEEE International Conference on Software Analysis, Evolution and Reengineering (SANER)10.1109/SANER53432.2022.00028(140-151)Online publication date: Mar-2022
https://doi.org/10.1109/SANER53432.2022.00028
Lamothe MGuéhéneuc YShang W(2021)A Systematic Review of API Evolution LiteratureACM Computing Surveys10.1145/347013354:8(1-36)Online publication date: 4-Oct-2021
https://dl.acm.org/doi/10.1145/3470133
Chen BAbedjan ZGrundy J(2021)Interactive cross-language code retrieval with auto-encodersProceedings of the 36th IEEE/ACM International Conference on Automated Software Engineering10.1109/ASE51524.2021.9678929(167-178)Online publication date: 15-Nov-2021
https://dl.acm.org/doi/10.1109/ASE51524.2021.9678929
Han LChen TDemartini GIndulska MSadiq SHuang JChang YCheng XKamps JMurdock VWen JLiu Y(2020)On Understanding Data Worker Interaction BehaviorsProceedings of the 43rd International ACM SIGIR Conference on Research and Development in Information Retrieval10.1145/3397271.3401059(269-278)Online publication date: 25-Jul-2020
https://dl.acm.org/doi/10.1145/3397271.3401059
Ren XSun JXing ZXia XSun JRothermel GBae D(2020)Demystify official API usage directives with crowdsourced API misuse scenarios, erroneous code examples and patchesProceedings of the ACM/IEEE 42nd International Conference on Software Engineering10.1145/3377811.3380430(925-936)Online publication date: 27-Jun-2020
https://dl.acm.org/doi/10.1145/3377811.3380430
Li JXing ZSun A(2019)LinkLiveWorld Wide Web10.1007/s11280-018-0621-y22:4(1699-1725)Online publication date: 1-Jul-2019
https://dl.acm.org/doi/10.1007/s11280-018-0621-y

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Abstract

References

Cited By

Index Terms

Recommendations

Exploring API embedding for API usages and applications

On Deprecated API Usages: An Exploratory Study of Top-Starred Projects on GitHub

Visual Cafe for Java Explorer: Database Development Edition

Comments

Information

Published In

Sponsors

Publisher

Publication History

Check for updates

Author Tags

Qualifiers

Conference

Acceptance Rates

Contributors

Other Metrics

Bibliometrics

Article Metrics

Other Metrics

Citations

Cited By

Login options

Full Access

View options

PDF

eReader

Share

Share this Publication link

Share on social media

Affiliations