Pete Freitag Pete Freitag

How to Design a Good API and Why it Matters

Updated on December 07, 2023
By Pete Freitag

Joshua Bloch has a good presentation outline called How to Design a Good API and Why it Matters. Joshua is a Principal Software Engineer for Google, before that an architect in Sun's Core Java Platform Group (he designed several of the standard java API's). Josh also wrote Effective Java (ISBN 0201310058).

Here are a few points from the presentation that I found interesting...

  • If you program, you are an API designer
  • If you keep the spec short, it?s easy to modify
  • API Should Do One Thing and Do it Well
  • API Should Be As Small As Possible But No Smaller
  • Names Matter - API is a Little Language
  • Fail Fast - Report Errors as Soon as Possible After They Occur

api design architecture bloch google sun java

How to Design a Good API and Why it Matters was first published on March 20, 2006.

If you like reading about api, design, architecture, bloch, google, sun, or java then you might also like:


The Fixinator Code Security Scanner for ColdFusion & CFML is an easy to use security tool that every CF developer can use. It can also easily integrate into CI for automatic scanning on every commit.

Try Fixinator

The weekly newsletter for the CFML Community