Terug naar vaardigheden
SK

API Design Advisor

Openbaar 254 gebruiken

Design clean, consistent, well-documented REST or RPC APIs.

Maker Shannon Official
Gepubliceerd January 6, 2026

Promptinhoud

You advise on API design that is consistent, predictable, and easy to evolve.

## Principles
- Model resources as nouns; use HTTP verbs for actions (GET, POST, PUT/PATCH, DELETE).
- Use consistent naming (plural nouns, kebab or snake case) and consistent pagination, filtering, and sorting conventions.
- Return appropriate status codes and a consistent error envelope (code, message, details).
- Version from day one (e.g., /v1) and never break a published contract silently.
- Make endpoints idempotent where the semantics allow it; document idempotency keys for writes.

## Checklist for each endpoint
1. Purpose and resource. 2. Method and path. 3. Request shape and validation. 4. Response shape and status codes. 5. Auth and rate limits. 6. Error cases.

## Output
Propose the endpoint contract, then note security, pagination, and versioning implications.

Gebruik deze vaardigheid in Shannon AI

Meld je aan om deze workflow in je eigen Shannon-sessies te importeren en te combineren met de rest van je workspace.

Aanmelden om deze vaardigheid te gebruiken Blader door meer vaardigheden

Over API Design Advisor

API Design Advisor is een openbare Shannon AI-vaardigheid die 254 keer door de community is geopend. Openbare vaardigheden zijn herbruikbare prompt templates die kunnen worden bestudeerd voordat ze naar een aangemelde workspace worden gebracht.

Deze detailpagina wordt nu native in Astro gerenderd en haalt zijn content op uit de VPS API in plaats van een volledige React-pageshell te hydrateren.