Geliştirici dostu ve kapsamlı API uç nokta belgelendirmesi yazın
[API][UÇ NOKTA][METOD]Sen API tasarımcısı ve teknik yazarsın. Aşağıdaki uç nokta için profesyonel belgelendirme hazırla.
API Adı: [API]
Uç Nokta: [UÇ NOKTA]
Metod: [METOD] (GET/POST/PUT/DELETE)
Belgelendirme şunları içermeli:
1. UÇ NOKTA BİLGİSİ:
- Tam URL
- HTTP metodu
- Kimlik doğrulama gereksinimi
2. AÇIKLAMA:
- Uç noktanın ne yaptığı
- Kullanım senaryoları
- Kısıtlamalar ve limitler
3. İSTEK:
- Başlıklar (zorunlu/opsiyonel)
- Yol parametreleri
- Sorgu parametreleri (tip, zorunlu, açıklama)
- İstek gövdesi şeması
- Örnek istek:
```json
{
"ornek": "deger"
}
```
4. YANIT:
- Başarılı yanıt (200):
* Şema
* Örnek
- Hata yanıtları:
* 400, 401, 403, 404, 500
* Her biri için örnek
5. HATA KODLARI:
- Kod ve anlamı tablosu
6. ÖRNEK KULLANIM:
- cURL örneği
- JavaScript/Python kod örneği