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.

referencesprovidersgcp.md

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

API design — GCP

Service mapping

  • API Gateway — managed gateway for REST/HTTP backends (Cloud Run, Functions, App Engine) configured from an OpenAPI spec; API keys, auth, basic quotas. The simple default for a public REST contract on serverless backends.
  • Apigee — full enterprise API management: versioning, quotas/spike-arrest, transformation, monetization, analytics. Use when you need rich policy, developer portals, and product packaging.
  • Cloud Endpoints — gateway/ESP proxy for REST and gRPC (OpenAPI or protobuf config), with auth and monitoring; sits in front of GKE/Compute/Cloud Run.
  • Global External HTTP(S) Load Balancer — L7 routing with gRPC and WebSocket support for service traffic (pairs with load-balancing).

When to pick which

API Gateway for a lightweight managed front on serverless; Endpoints when you need gRPC or an ESP sidecar in front of GKE; Apigee for enterprise policy/quotas/portal; the HTTP(S) LB for plain global routing of gRPC/WebSocket.

Limits / things that bite (verify against current docs)

  • API Gateway / serverless backends (Cloud Run, Functions) have request timeout and payload caps — long calls must go async; tune the backend timeout too.
  • Quota/spike-arrest semantics differ: Apigee's spike-arrest smooths bursts, API Gateway's quotas are coarser — know which you're getting.
  • Apigee is a heavyweight, higher-cost platform; API Gateway is far lighter — don't reach for Apigee unless its policy/portal features are needed.
  • WebSocket via the HTTP(S) LB has connection-duration and timeout caps; long-lived clients reconnect.

Pitfalls

  • Reaching for Apigee (cost, complexity) when API Gateway or Endpoints suffices.
  • Assuming the gateway provides idempotency — it doesn't; build the idempotency-key store (Firestore/Memorystore with TTL).
  • Forgetting Cloud Run/Functions backend timeouts compound with the gateway's.
  • Lock-in via Apigee policies and Endpoints ESP 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