Require that every API follows a single, documented set of naming conventions for resources, fields, parameters, and enums, so a developer who learns one of our APIs already understands the next. Every API must be consistent about casing, pluralization, and vocabulary, because these small choices are the texture a consumer feels on every call. I care about this more than it may seem, since inconsistent naming is one of the loudest signals that an organization has no real governance behind its APIs. When names are predictable, the whole platform reads like it was built by one thoughtful team, and that consistency compounds into a genuinely better developer experience.
Naming Conventions (Design)
Strategies
APIs Follow Consistent Design Patterns
All APIs must follow consistent design patterns for naming conventions, media types, pagination, filtering, sorting, and error handling, ensuring that consumers can learn patterns once and apply th...
Experiences
Consistency
Achieving consistency in the design, delivery, and maintenance of HTTP APIs across an enterprise is a significant challenge—one that often complicates API operations. Small differences, such as var...
Developer Experience
Developer experience is the sum of every interaction a developer has with an API, from the first time they land on the portal to the hundredth time they call an endpoint in production. It covers do...
Standardization
The standardization of APIs will shape the overall experience producing and consuming APIs. The number of and types of standardizations will shape the design of the API itself, as well as the onboa...
Lifecycle
design_services Design Design
Design is where the human experience of an API is won or lost. I work design-first, shaping the paths, schema, errors, and naming in the contract before development begins, so that consistency is b...
