CoChat

A Theory of Robust API Knowledge

Thayer, Kyle, Chasins, Sarah E., Ko, Amy J. · 2021 · ACM Transactions on Computing Education

The DOI matches its Crossref record; 49 of the 50 references it cites were found in a registry or an index.

Abstract

Creating modern software inevitably requires using application programming interfaces (APIs). While software developers can sometimes use APIs by simply copying and pasting code examples, a lack of robust knowledge of how an API works can lead to defects, complicate software maintenance, and limit what someone can express with an API. Prior work has uncovered the many ways that API documentation fails to be helpful, though rarely describes precisely why. We present a theory of robust API knowledge that attempts to explain why, arguing that effective understanding and use of APIs depends on three components of knowledge: (1) the domain concepts the API models along with terminology, (2) the usage patterns of APIs along with rationale, and (3) facts about an API’s execution to support reasoning about its runtime behavior. We derive five hypotheses from this theory and present a study to test them. Our study investigated the effect of having access to these components of knowledge, finding that while learners requested these three components of knowledge when they were not available, whether the knowledge helped the learner use or understand the API depended on the tasks and likely the relevance and quality of the specific information provided. The theory and our evidence in support of its claims have implications for what content API documentation, tutorials, and instruction should contain and the importance of giving the right information at the right time, as well as what information API tools should compute, and even how APIs should be designed. Future work is necessary to both further test and refine the theory, as well as exploit its ideas for better instructional design.

Overview

Integrity signals

Registry

Crossref · 10.1145/3444945

Cites

49 of 49 references verified0 citation errors · 0 not checkable

Statistics

Recomputing p-values needs the paper’s full text.

Verification

Claims the paper makes

This paper’s full text isn’t openly available, so its claims and self-check weren’t run. The registry and citation checks still apply.

Citations

Cites

Show all 49 references

Research works printed but not linked: 6

  1. Steven Clarke . 2004. Measuring API usability. Dr. Dobb’s Journal , Special Windows/.NET Supplement (May 2004 ). Retrieved from http://www.drdobbs.com/windows/measuring-api-usability/184405654. Steven Clarke. 2004. Measuring API usability. Dr. Dobb’s Journal, Special Windows/.NET Supplement (May 2004). Retrieved from http://www.drdobbs.com/windows/measuring-api-usability/184405654.
  2. Ekwa Duala-Ekoko and Martin P . Robillard . 2010 . The Information Gathering Strategies of API Learners. Technical ReportTR-2010.6, School of Computer Science, McGill University . Retrieved from https://pdfs.semanticscholar.org/a7ff/4cc954744f761e8697be4e73aa25166a76c4.pdf. Ekwa Duala-Ekoko and Martin P. Robillard. 2010. The Information Gathering Strategies of API Learners. Technical ReportTR-2010.6, School of Computer Science, McGill University. Retrieved from https://pdfs.semanticscholar.org/a7ff/4cc954744f761e8697be4e73aa25166a76c4.pdf.
  3. Patrick Suppes . 1967 . What is a scientific theory? In Philosophy of Science Today, Sidney Morgenbesser (Ed.) , Chapter 6. 55 -- 67 . Patrick Suppes. 1967. What is a scientific theory? In Philosophy of Science Today, Sidney Morgenbesser (Ed.), Chapter 6. 55--67.
  4. Kyle Matthew Thayer. 2020. Practical Knowledge Barriers in Professional Programming. Thesis. Retrieved from https://digital.lib.washington.edu:443/researchworks/handle/1773/45471. Kyle Matthew Thayer. 2020. Practical Knowledge Barriers in Professional Programming. Thesis. Retrieved from https://digital.lib.washington.edu:443/researchworks/handle/1773/45471.
  5. 10.5555/2337223.2337321 · doi:10.5555/2337223.2337321
  6. Leonid_2. 2015 . English: A simple torus fading out to a wireframe structure. Leonid_2. 2015. English: A simple torus fading out to a wireframe structure.

Cited by

See all 32

Metadata

Authors
Thayer, K., Chasins, S. E., & Ko, A. J.
Affiliations
  • University of Washington (US)
  • University of California, Berkeley (US)
Venue
ACM Transactions on Computing Education
Published
2021-01-28
Volume
21
Issue
1
Pages
1-32
ISSN
1946-6226 (ISSN-L)
OpenAlex
W3128009513
Cited by
25
References
50
Citations by year
2026: 2 · 2025: 1 · 2024: 6 · 2023: 7 · 2022: 6 · 2021: 3
FWCI
4.97
Type
journal article
Language
en
Open access
closed
Locations
ACM Transactions on Computing Education (publishedVersion)
Funders
National Science Foundation (1703304, 1735123, and 1836813.)
Topics
  • Physical Sciences › Computer Science › Information Systems › Software Engineering Research
  • Physical Sciences › Computer Science › Computer Science Applications › Teaching and Learning Programming
  • Physical Sciences › Computer Science › Information Systems › Software Engineering Techniques and Practices
Keywords
application programming interfaces, API documentation, software learning, domain concepts, API usage patterns, API design, instructional design, software maintenance

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: A Theory of Robust API Knowledge. https://app.cochat.ai/papers/10.1145/3444945
The paper
Thayer, K., Chasins, S. E., & Ko, A. J. (2021). A Theory of Robust API Knowledge. ACM Transactions on Computing Education. https://doi.org/10.1145/3444945

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.