TY - GEN
T1 - API caveat explorer - Surfacing negative usages from practice
T2 - 41st Annual International ACM SIGIR Conference on Research and Development in Information Retrieval, SIGIR 2018
AU - Li, Jing
AU - Sun, Aixin
AU - Xing, Zhenchang
AU - Han, Lei
N1 - Publisher Copyright:
© 2018 Authors.
PY - 2018/6/27
Y1 - 2018/6/27
N2 - 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.
AB - 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.
KW - Interactive exploratory search
KW - Text summarization
KW - User-generated content
UR - http://www.scopus.com/inward/record.url?scp=85050372338&partnerID=8YFLogxK
U2 - 10.1145/3209978.3210170
DO - 10.1145/3209978.3210170
M3 - Conference contribution
T3 - 41st International ACM SIGIR Conference on Research and Development in Information Retrieval, SIGIR 2018
SP - 1293
EP - 1296
BT - 41st International ACM SIGIR Conference on Research and Development in Information Retrieval, SIGIR 2018
PB - Association for Computing Machinery, Inc
Y2 - 8 July 2018 through 12 July 2018
ER -