Access Patterns
Compliance checks that govern how components communicate over the network, design their APIs, and handle the inherent unreliability of distributed access. These checks ensure consistent, resilient, and well-behaved network interactions across all platforms.
Applicability
Recipes or guidelines involving network communication, API calls, data synchronization, or client-server interaction.
Checks
api-design-conventions
APIs MUST follow RESTful conventions with consistent naming and versioning.
Applies when: a component exposes or consumes an HTTP API.
Guidelines:
offline-behavior
Components MUST define behavior when network is unavailable.
Applies when: a feature depends on network connectivity to function.
Guidelines:
retry-with-backoff
Failed network requests MUST implement retry with exponential backoff and jitter.
Applies when: a component makes network requests that may transiently fail.
Guidelines:
timeout-configuration
All network requests MUST have configured timeouts; MUST NOT wait indefinitely.
Applies when: a component initiates any network request.
Guidelines:
rate-limit-handling
Clients MUST handle HTTP 429 responses and respect Retry-After headers.
Applies when: a component calls rate-limited APIs or services.
Guidelines:
pagination-support
Endpoints returning collections MUST support pagination.
Applies when: an API endpoint returns a list of resources.
Guidelines:
reconnection-strategy
Real-time connections MUST define reconnection behavior with backoff.
Applies when: a component uses WebSockets, server-sent events, or other persistent connections.
Guidelines:
error-response-handling
Clients MUST handle all documented error response codes gracefully.
Applies when: a component consumes an API that defines error responses.
Guidelines: