Go Idiomatic API Design

Design from the caller's code inward. Prefer the smallest coherent public surface that preserves invariants and can evolve without needless interfaces.

Core Workflow

1. Identify callers, supported operations, and compatibility constraints.
2. Sketch realistic call sites before choosing exported names or types.
3. Keep packages cohesive and names clear without package-name stutter.
4. Prefer concrete provider APIs; define narrow interfaces at consumers.
5. Decide zero-value, mutation, copying, concurrency, and error contracts.
6. Review embedding, receiver method sets, typed nils, generics, and option conflicts.
7. Integrate standard interfaces only when their semantics truly match.
8. Prove the public surface with external tests and executable examples.
9. Review the change for accidental compatibility commitments.

Read Next