Improving API Caveats Accessibility by Mining API Caveats Knowledge Graph
The DOI matches its Crossref record; 4 of the 4 references it cites were found in a registry or an index.
Abstract
API documentation provides important knowledge about the functionality and usage of APIs. In this paper, we focus on API caveats that developers should be aware of in order to avoid unintended use of an API. Our formative study of Stack Overflow questions suggests that API caveats are often scattered in multiple API documents, and are buried in lengthy textual descriptions. These characteristics make the API caveats less discoverable. When developers fail to notice API caveats, it is very likely to cause some unexpected programming errors. In this paper, we propose natural language processing(NLP) techniques to extract ten subcategories of API caveat sentences from API documentation and link these sentences to API entities in an API caveats knowledge graph. The API caveats knowledge graph can support information retrieval based or entity-centric search of API caveats. As a proof-of-concept, we construct an API caveats knowledge graph for Android APIs from the API documentation on the Android Developers website. We study the abundance of different subcategories of API caveats and use a sampling method to manually evaluate the quality of the API caveats knowledge graph. We also conduct a user study to validate whether and how the API caveats knowledge graph may improve the accessibility of API caveats in API documentation.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cites
Landis, J. R., & Koch, G. G. (1977) · Biometrics · doi:10.2307/2529786 · Cited by 4,332 · cited 1×
“Then, we compute Cohen’s Kappa [45] to evaluate the inter-rater agreement.”
MethodMyers, B. A., & Stylos, J. (2016) · Communications of the ACM · doi:10.1145/2896587 · Cited by 269
What help do developers seek, when and how?
Li, H., Xing, Z., Peng, X., & Zhao, W. (2013) · 2013 20th Working Conference on Reverse Engineering (WCRE) · doi:10.1109/wcre.2013.6671289 · Cited by 81
Self-citationImproving automated documentation to code traceability by combining retrieval techniques
Chen, X., & Grundy, J. (2011) · 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011) · doi:10.1109/ase.2011.6100057 · Cited by 50
Cited by
Enhancing State-of-the-art Classifiers with API Semantics to Detect Evolved Android Malware
Zhang, X., Zhang, Y., Zhong, M., Ding, D., Cao, Y., Zhang, Y., Zhang, M., & Yang, M. (2020) · Proceedings of the 2020 ACM SIGSAC Conference on Computer and Communications Security · doi:10.1145/3372297.3417291 · Cited by 185
Zhao, X., Liu, S., Yang, S.-Y., & Miao, C. (2025) · Proceedings of the ACM on Web Conference 2025 · doi:10.1145/3696410.3714782 · Cited by 116
“Although LLMs fine-tuned on medical datasets can handle large amounts of unstructured clinical information, most of these models are heuristic-based, with limitations such as generating incorrect or vague information and struggling to handle complex patient cases [24, 62].”
Self-citationEnabling Data-Driven API Design with Community Usage Data: A Need-Finding Study
Zhang, T., Hartmann, B., Kim, M., & Glassman, E. L. (2020) · Proceedings of the 2020 CHI Conference on Human Factors in Computing Systems · doi:10.1145/3313831.3376382 · Cited by 25
“, API usage tips [29, 55], test cases [36, 34], analogical libraries [7, 8], bug fixing hints [9, 20, 61].”
BackgroundKnowledge Graphing Git Repositories: A Preliminary Study
Zhao, Y., Wang, H., Ma, L., Liu, Y., Li, L., & Grundy, J. (2019) · 2019 IEEE 26th International Conference on Software Analysis, Evolution and Reengineering (SANER) · doi:10.1109/saner.2019.8668034 · Cited by 14
“In recent years, researchers have demonstrated that knowledge graphs are useful for various purposes such as constructing question-answering websites [15], [16], [18], [20], [21], representing API caveats from the API documentation [17], performing semantic rankings [19], etc.”
BackgroundWang, M., Shen, Y., Zhao, B., Zhou, X., Sun, L., & Liu, X. (2025) · Health Information Science and Systems · doi:10.1007/s13755-025-00379-x · Cited by 3
Metadata
- Authors
- Li, H., Li, S., Sun, J., Xing, Z., Peng, X., Liu, M., & Zhao, X.
- Venue
- 2018 IEEE International Conference on Software Maintenance and Evolution (ICSME)
- Publisher
- IEEE
- Published
- 2018-09
- Pages
- 183-193
- OpenAlex
- W2901934569
- Cited by
- 97
- References
- 4
- FWCI
- 8.37
- Type
- conference paper
- Language
- en
- Open access
- closed
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
How to cite
Cite CoChat for the checks on this page, and the paper for its own findings.
- This page
- CoChat. (2026). Citation check: Improving API Caveats Accessibility by Mining API Caveats Knowledge Graph. https://app.cochat.ai/papers/10.1109/icsme.2018.00028
- The paper
- Li, H., Li, S., Sun, J., Xing, Z., Peng, X., Liu, M., & Zhao, X. (2018). Improving API Caveats Accessibility by Mining API Caveats Knowledge Graph. 2018 IEEE International Conference on Software Maintenance and Evolution (ICSME). https://doi.org/10.1109/icsme.2018.00028
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.