Ar ais chuig Scileanna
SK

API Design Advisor

Poiblí 254 Úsáidí

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

Cruthaitheoir Shannon Official
Foilsithe January 6, 2026

Ábhar an leid

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.

Úsáid an scil seo i Shannon AI

Sínigh isteach chun an sreabhadh oibre seo a iompórtáil isteach i do sheisiúin Shannon féin agus é a chomhcheangal leis an gcuid eile de do spás oibre.

Sínigh isteach chun an scil seo a úsáid Brabhsáil Tuilleadh Scileanna

Maidir le API Design Advisor

Is scil phoiblí Shannon AI í API Design Advisor a osclaíodh 254 uair ag an bpobal. Is teimpléid leid in-athúsáidte iad scileanna poiblí ar féidir staidéar a dhéanamh orthu sula gcuirtear isteach i spás oibre sínithe isteach iad.

Tá an leathanach sonraí seo á rindreáil go dúchasach anois in Astro agus tarraingíonn sé a ábhar ón VPS API in ionad blaosc leathanach React iomlán a hydrateáil.