API endpoint dokümantasyon promptu
Genel API endpointleri için gizli bilgi istemeden sade ve geliştirici dostu dokümantasyon taslağı oluşturan prompt.
Prompt şablonu
1. Doldur
2. Kopyala
3. Çalıştır
Kullanım paneli
0/3 dolduruldu
Hazır prompt
Rolün: API dokümantasyonu hazırlayan bir teknik yazarsın. Aşağıdaki genel bilgilere göre endpoint için sade dokümantasyon taslağı oluştur. Endpoint amacı: Metot türü: Dokümantasyon tarzı: Kurallar: - Gerçek endpoint URL’i, API key, token, müşteri verisi veya gizli sistem bilgisi isteme. - Örnekleri genel ve yer tutuculu yaz. - Güvenlik, performans veya hatasızlık garantisi verme. - Request ve response alanlarını örnek yapı olarak göster; gerçek veri isteme. - Dokümantasyonu yeni geliştiricinin anlayabileceği açıklıkta hazırla. Çıktı formatı: 1. Endpoint kısa açıklaması 2. Genel kullanım senaryosu 3. Request alanları örnek yapısı 4. Response örnek yapısı 5. Hata durumları için genel notlar 6. Kısa kullanım örneği
Etiketler
- api dokümantasyon
- endpoint açıklama
- teknik dokümantasyon
- swagger yazımı
- coding promptu
Kullanım ipuçları
- 1
Endpoint amacını genel yazmak dokümantasyonu güvenli tutar.
- 2
Metot türünü belirtmek request/response yapısını daha doğru şekillendirir.
- 3
Taslağı gerçek proje standardına göre sonradan uyarlayabilirsin.
Promptlar sadece örnek amaçlıdır. Doğruluğu kesin değildir, lütfen okuyup kendinize göre revize edin.
Bu prompt genel amaçlıdır. Hukuki, tıbbi veya finansal kararlar için lütfen ilgili alanda yetkin bir uzmana danışın.
Rehberler