domains / families / software-engineering / api-patterns

api-patterns

authentic

API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.

When to use

• Use when defining a new endpoint contract, selecting REST/GraphQL/tRPC for known consumers, or changing pagination, errors, authentication or compatibility behavior. For a bug inside an existing contract, preserve that contract unless the…

When not to use

• The Python helper scans at most 15 matching files using regular expressions and shallow JSON/YAML checks. Its output is a triage hint, not OpenAPI validation, an authorization audit or deployment approval.
• GraphQL query shape, tRPC inference and HTTP method names do not enforce resource authorization or backwards compatibility.
• Rate limiting cannot alone prevent all resource exhaustion; size, concurrency, time and provider-cost bounds depend on the operation.
• Perform security checks only against authorized local/test targets with isolated accounts and a defined scope.

Skill page

Source