Air ais gu Sgilean
SK

API Design Advisor

Poblach 254 Cleachdaidhean

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

Cruthaiche Shannon Official
Air fhoillseachadh January 6, 2026

Susbaint a’ phrompt

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.

Cleachd an sgil seo ann an Shannon AI

Clàraich a-steach gus an sruth-obrach seo a thoirt a-steach do na seiseanan Shannon agad fhèin agus a chur còmhla ris a’ chòrr dhen àite-obrach agad.

Clàraich a-steach gus an sgil seo a chleachdadh Dèan brobhsadh air barrachd sgilean

Mu dheidhinn API Design Advisor

Tha API Design Advisor na sgil phoblach Shannon AI a chaidh fhosgladh 254 uair leis a’ choimhearsnachd. Tha sgilean poblach nan teamplaidean prompt ath-chleachdte a ghabhas sgrùdadh mus tèid an toirt a-steach do dh’àite-obrach far a bheil thu air clàradh a-steach.

Tha an duilleag mionaideach seo a-nis air a renderadh gu dùthchasach ann an Astro agus a’ tarraing a susbaint bhon VPS API an àite slige duilleig React slàn a hydrateadh.