Posts

Showing posts from January, 2019

Main characteristics of APIs

1. Understandable (give consideration to the entry points into their API) 2. Well-documented 3. Consistent (methods should have the form getXYZ() or xyz(), but not both forms) 4. Fit for purpose (Do only one thing, and do it right) 5. Restrained (API can happen almost too quickly, we are potentially committing to a lifetime of support) 6. Evolvable (view them in the wider context) Read API best practices here: https://dzone.com/refcardz/java-api-best-practices