Back to registry
1.2.3•Public•Updated 1 week ago

api/design-rules

OfficialRule

Reusable API standards for REST naming, pagination, errors, validation, auth and rate-limit behavior.

Readme

active

Content

Rule

Dependencies

2

Dependents

511

Versions

1.2.3

api/design-rules README

Apply these rules when designing or reviewing API contracts.

The package defines response shape, error contract, pagination, filters, idempotency, caching headers and auth expectations.

Recommended usage

  • 1. Install the package using the CLI command.
  • 2. Review generated files before approving them for team use.
  • 3. Publish only approved versions to the organization registry.
  • 4. Track updates and roll back when a context change behaves badly, because naturally that will happen on a Friday.

Governance

Supports review, approval, version history and private organization distribution.

Compatibility

Cursor, Claude Code, GitHub Copilot