திறன்களுக்கு திரும்பு
SK

API Design Advisor

பொது 254 பயன்பாடுகள்

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

உருவாக்கியவர் Shannon Official
வெளியிடப்பட்டது January 6, 2026

Prompt உள்ளடக்கம்

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.

இந்த திறனை Shannon AI இல் பயன்படுத்துங்கள்

இந்த workflow ஐ உங்கள் Shannon session களில் import செய்து, உங்கள் workspace இன் மற்ற பகுதிகளுடன் இணைக்க உள்நுழைக.

இந்த திறனை பயன்படுத்த உள்நுழைக மேலும் திறன்களை உலாவு

API Design Advisor பற்றி

API Design Advisor என்பது சமூகத்தால் 254 முறை திறக்கப்பட்ட பொது Shannon AI திறன். பொது திறன்கள் என்பது signed-in workspace க்கு கொண்டு வருவதற்கு முன் ஆய்வு செய்யக்கூடிய reusable prompt templates ஆகும்.

இந்த விவரப் பக்கம் இப்போது Astro இல் native ஆக render செய்யப்படுகிறது; இது முழு React page shell ஐ hydrate செய்வதற்குப் பதிலாக VPS API இலிருந்து உள்ளடக்கத்தை இழுக்கிறது.