Yeteneklere Geri Dön
SK

API Design Advisor

Herkese Açık 254 kullanım

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

Oluşturan Shannon Official
Yayınlandı January 6, 2026

İstem İçeriği

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.

Bu yeteneği Shannon AI içinde kullanın

Bu iş akışını kendi Shannon oturumlarınıza aktarmak ve çalışma alanınızın geri kalanıyla birleştirmek için oturum açın.

Bu Yeteneği Kullanmak İçin Oturum Aç Daha Fazla Yeteneğe Göz At

API Design Advisor Hakkında

API Design Advisor, topluluk tarafından 254 kez açılmış herkese açık bir Shannon AI yeteneğidir. Herkese açık yetenekler, oturum açılmış bir çalışma alanına taşınmadan önce incelenebilen reusable prompt templates'tir.

Bu detay sayfası artık yerel olarak Astro içinde render ediliyor ve tüm React sayfa kabuğunu hydrate etmek yerine içeriğini VPS API'den çekiyor.