
Good API Design Principles: Building Lasting Interfaces
This is the CitePep accuracy record for “Good API Design Principles: Building Lasting Interfaces”, published by When Notes Fly. It lists every change experts checked and accepted on that page.
API design principles: Twitter's API built an ecosystem from 2006, then restrictions in 2012 and 2023 broke thousands of apps overnight.
What is this page about?
A guide to good API design principles, the conventions that determine whether an API stays intuitive, stable, and evolvable as developers adopt it.
It covers resource-oriented design and the noun-verb distinction, HTTP methods as a semantic vocabulary, hierarchical URL design, consistency in naming and response structure, error handling with correct status codes and actionable messages,
versioning and what counts as a breaking change, authentication and authorization, pagination and filtering, and documentation via the OpenAPI specification.
What has been corrected on this page?
Every accepted correction to this page is recorded with the exact change, so readers can see how the page improved over time.
-
A claim-level statistics check of this article: 2 study claims with no locatable published source were removed.
BeforeA 2018 empirical study by Titus Barik and colleagues at Microsoft Research validated this principle by analyzing Stack Overflow questions related to 40 popular Java and .NET APIs. | APIs rated as "easy to misuse" by Bloch's criteria generated 3.2 times more Stack Overflow questions per unique user than APIs rated as "hard to misuse," directly measuring the developer effort cost of poor design.
AfterRemoved. | Removed.
Why: Each study and survey figure in the article was checked against the published source. Claims for which no published source could be located were removed.
View the full record → -
2 corrections applied: Twitterrific launched 2007, TweetDeck and HootSuite in 2008 - not 'within months' of the 2006 API; the ecosystem developed over a few years | The $817 billion figure was Stripe's 2022 total payment volume (reported early 2023); 2023 was roughly $1 trillion
BeforeWithin months, an entire ecosystem of applications emerged over the next few years: Twitterrific, TweetDeck, HootSuite...
AfterOver the next few years, an entire ecosystem of applications emerged: Twitterrific, TweetDeck, HootSuite...
Why: The Stripe $817B/2022 fix was already correctly applied, but a residual self-contradictory phrase survived a prior partial edit: 'Within months, ...emerged over the next few years' mixed the original unverified rapid-timeline claim with the corrected multi-year framing. Removed 'Within months,' so the sentence consistently reflects gradual ecosystem growth.
View the full record →
Who checked this page?
2 contributors have checked "Good API Design Principles: Building Lasting Interfaces" on When Notes Fly. Each name below links to that person's public CitePep profile, where every contribution they have made is listed with the exact change they proposed.