API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Path Names

Requiring API paths meets the policy standards that are set.

Rules

OpenAPI No Path Trailing Slash Error

It is common to be explicit and consistent about whether or not to have a trailing slack on each API path

OpenAPI No Path Trailing Slash Info

It is common to be explicit and consistent about whether or not to have a trailing slack on each API path

OpenAPI Version In Path Error

The majority of public APIs available on the Web today put the major version of the API as part of the path for each API

OpenAPI Version In Path Info

The majority of public APIs available on the Web today put the major version of the API as part of the path for each API

Strategies

API Paths Must Conform to the Organization

Your API paths are the most visible thing you put out there, and when they don't follow any organizational standard, the whole thing feels like a junk drawer. I keep finding APIs where every team i...

APIs Follow Consistent Design Patterns

Consistency is one of the most underrated qualities in the API landscape. When consumers learn your patterns for naming, pagination, filtering, and error handling once and can apply them across eve...