Index of every page on this site: llms.txt
All skills
proyecto26 avatar

/api-design

@228d57d
Run it yourself

This skill should be used when the user needs to "design the API", do "endpoint design", pin down a "request/response shape", choose a "pagination" strategy (cursor vs offset), add an "idempotency key" to a write, plan "API versioning", an "error contract", or pick between "REST vs gRPC vs GraphQL" or "WebSocket vs polling". Use it whenever a design has reached the interface — the concrete request, response, primary access path, and how clients page, retry, and version — even if the user only said "the boxes talk to each other".

Use this Skill: https://skilld.dev/gh/proyecto26/system-design-skills/api-design

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesprovidersazure.md

≈491 tokens on demand. Your agent reads this file only when SKILL.md points to it.

API design — Azure

Service mapping

  • API Management (APIM) — managed API gateway: versioning/revisions, products
    • subscription keys, rate-limit/quota policies, request/response transformation, validation. The default front for public REST/gRPC/GraphQL contracts.
  • Application Gateway — L7 load balancer with WAF and path/host routing; supports WebSocket and gRPC pass-through. Use for service traffic when you don't need APIM's full policy layer (pairs with load-balancing).
  • Web PubSub / SignalR Service — managed WebSocket/real-time push; Azure holds the connections so you don't run a stateful fleet.
  • APIM also fronts GraphQL (pass-through or synthetic) with the same policy engine.

When to pick which

APIM when you need versioning, keys/quotas, and policy transforms on a public API; Application Gateway for WAF + L7 routing of plain HTTP/gRPC/WebSocket; Web PubSub/SignalR for managed push without operating connection servers.

Limits / things that bite (verify against current docs)

  • APIM throughput, policy complexity, and features are tier-bound (Consumption vs Developer vs Standard/Premium); Consumption is serverless but has cold-start and feature gaps, Premium adds VNet + multi-region.
  • Rate-limit/quota policies are enforced per APIM instance/scope — multi-region or scaled-out APIM needs care to enforce a single global limit.
  • APIM request timeout and body-size caps apply; long calls must go async.
  • Web PubSub/SignalR bill per connection + message and cap concurrent connections per tier.

Pitfalls

  • Choosing a low APIM tier then needing VNet/multi-region (a tier migration).
  • Assuming APIM provides idempotency — it doesn't; build the idempotency-key store yourself (Cosmos DB / Redis with TTL).
  • Treating per-instance rate limits as global across a scaled-out deployment.
  • Lock-in via APIM policy expressions and named-value config that don't port out.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts24d3 checks · Risk SAFE
  • Gen Agent Trust Hub24d

    The skill provides architectural guidance and best practices for designing APIs, covering protocols, pagination, and idempotency. No security issues were detected.

  • Socket24d

    No alerts

  • Snyk24d

    Risk: LOW · No issues

Signed by skilld at 228d57d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 weeks ago.

Activeupdated 4 weeks ago

README badge

README badge for proyecto26/system-design-skills/api-design