Requiring API paths meets the policy standards that are set.
Path Names
Rules
OpenAPI No Api In Path Error
API paths must not contain a redundant "api" segment, since the fact that a resource is an API is already implied by the endpoint and adds no value.
OpenAPI No Api In Path Info
API paths should not contain a redundant "api" segment, since the fact that a resource is an API is already implied by the endpoint and adds no value.
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
All API paths must conform to the overall organizational domain standards, utilizing plain language and a resourceful approach to delivering digital resources and capabilities via HTTP APIs, provid...
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...
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...
