RSS feed [root] /design /weblog



title search:


Mon Nov 13 00:44:30 HKT 2017

API design guideline

This is a message from a management blog, but I think the arguement is also apply API design. In fact, I think most critical difference of good and bad API is knowing which small detail is important and which is not -[..]

Design tips:[..]gView?showComments=true&entry=3258158706[..]its-of-highly-profitable-developers.html

About Compatibility issues

A blog of using interfaces-vs-abstract-classes[..]6/04/interfaces-vs-abstract-classes.html

XOM design overview -

You need to identify the business value but not pick any tools/design just because it is cool -

A lot of links here -

An introduction of good OSS project to study their source -[..]com/2007/06/28/learning-from-the-source/


Discussion of why getting feedback quick is important -[..]u-dont-know-until-you-take-the-next-step

Someone saying that routines is the greatest invention in CS, I agree -

New way of modeling system then layering, The Onion Architecture -

SOLID -[..]of-the-month-march-solid-principles.aspx <-- very good picture!

Idempotent, Orthogonality, Immutability -

Some example of how to driven good API -[..]al/2009/5/11/good-api-design-part-3.html

It's not enough to write tests for an API you develop, you have to write unit tests for code that uses your API. When you do, you learn first-hand the hurdles that your users will have to overcome when they try to test their code independently.[..]MichaelFeathers.TheGoldenRuleOfApiDesign

Active interface vs. Passive interface, for me this is another way to under "Tell, don't ask" -[..]-on-api-design-call-stack-as-source.html

The Principles of Good Programming -[..]software-principles-you-must-understand/

Difference choice of how API evolute with change -[..]sive-api-evolution-with-java-interfaces/

JUnit's evolving structure. -

API performance contract -

Consistent naming conventions
Standard terminology
Uniform error responses
Attention to detail (that’s the love part for APIs)
REST APIs that work with only 2 resources and use 4 HTTP verbs (oh, there is so much more to talk about here…)
Avoid API design by way of method-driven approach – that leads you down a slippery slope
- See more at:[..]are-like-parenting/#sthash.Ux1LHMNU.dpuf[..]ake-this-mistake-when-developing-an-spi/

Guideline for webapi -

(google search) (amazon search)
download zip of files only