API Design Advisor
Publik 254 penggunaan
Design clean, consistent, well-documented REST or RPC APIs.
Semua bahasa setara. Pilih bahasa yang ingin Anda gunakan untuk menjelajah.
Design clean, consistent, well-documented REST or RPC APIs.
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.
Masuk untuk mengimpor workflow ini ke sesi Shannon Anda sendiri dan menggabungkannya dengan bagian lain dari workspace Anda.
API Design Advisor adalah skill Shannon AI publik yang telah dibuka 254 kali oleh komunitas. Skill publik adalah templat prompt yang dapat digunakan ulang dan dapat dipelajari sebelum dibawa ke workspace yang sudah login.
Halaman detail ini kini dirender secara native di Astro dan mengambil kontennya dari VPS API alih-alih menghidrasi seluruh shell halaman React.