Kembali ke Kemahiran
SK

API Design Advisor

Awam 254 penggunaan

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

Pencipta Shannon Official
Diterbitkan January 6, 2026

Kandungan 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.

Gunakan kemahiran ini dalam Shannon AI

Log masuk untuk import workflow ini ke dalam sesi Shannon anda sendiri dan gabungkannya dengan seluruh workspace anda.

Log Masuk untuk Guna Kemahiran Ini Layari Lagi Kemahiran

Tentang API Design Advisor

API Design Advisor ialah kemahiran Shannon AI awam yang telah dibuka 254 kali oleh komuniti. Kemahiran awam ialah prompt templates boleh guna semula yang boleh dikaji sebelum dibawa ke workspace yang telah log masuk.

Halaman butiran ini kini dirender secara native dalam Astro dan menarik kandungannya daripada API VPS dan bukannya menghidrat seluruh shell halaman React.