01Kontrol edilen başlıklar
- Sunucu ve uygulama logları
- Search Console ve analitik verileri (web işlerinde)
- Lighthouse ve PageSpeed ölçümleri
- Sunucu kaynak kullanımı (işlemci, bellek, disk)
- Sürüm, bağımlılık ve güvenlik güncelleme durumu
- Belirti kontrolü: küçük bir değişikliğin başka yerleri bozması
- Belirti kontrolü: kodu yazan kişiye veya firmaya ulaşılamaması
02Rapor içeriği
- Bulgular ve kanıtlar
- Önceliklendirilmiş sorun listesi
- Önerilen çözüm ve etkisi
- Riskler ve ön koşullar
- Uygulama planı
03Belirti, neden ve çözüm
| Belirti | Olası neden | Çözüm |
|---|---|---|
| İş ortakları API'yi yanlış kullanıyor | Dokümantasyon eksik veya güncel değil | OpenAPI şeması, örnek istekler ve sürüm notları |
| API yoğunlukta yavaşlıyor | Kota ve önbellek yok, sorgular optimize değil | Oran sınırı, önbellek ve sorgu iyileştirme |
| Webhook bildirimleri kayboluyor | Yeniden deneme ve teslim kaydı yok | İmzalı webhook, kuyruk ve teslim logu |
| Eski sürümü kullananlar bozuluyor | Sürümleme ve geçiş takvimi yok | Sürümlü uç noktalar ve duyurulu kullanım dışı bırakma |
04Analizde kullanılan ölçütler
| Metrik | Hedef | Nasıl ölçülür |
|---|---|---|
| Açık kritik hata | 0 | Hata takip sistemi |
| Test kapsamı | Kritik akışları kapsıyor | Test raporları |
| Ortalama düzeltme süresi | Azalan eğilim | Hata kayıtları |
| Güncel olmayan bağımlılık | Kritik olan yok | Bağımlılık tarama raporu |
05İşletim ve bakım ipuçları
- Eski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
- Webhook teslim hataları ve yeniden denemeler raporlanır.
- Dokümantasyon her sürümle birlikte güncellenir.
06API dokümantasyonu hangi işletmelerde kullanılır?
- Kurumsal BT ekipleri
- Yazılım şirketleri
- İş ortağı ekosistemi olan firmalar
- Platform kuran girişimler
07Hangi durumlarda gündeme gelir?
Kılavuz gerektiğinde
Kılavuz, API dokümantasyonu projesinde kapsamın başında konuşulan başlıklardandır; analizde kimin kullanacağı ve nasıl çalışacağı netleştirilir.
Verinizi iş ortaklarına açmak istediğinizde
API dokümantasyonu ile veri, yetki ve kota kontrolüyle güvenli biçimde dış sistemlere sunulur.
08Derinkuyu'da uzaktan analiz
Derinkuyu, Nevşehir iline bağlı bir ilçedir ve PTT adres verisine göre 34 mahalle ve köy kaydından oluşur.
Mesafe yazılım işinin önünde engel değildir: Derinkuyu'daki ekiplerle görüntülü görüşme, ekran paylaşımı ve test ortamı bağlantısıyla çalışılır; cihaz kurulumu veya saha keşfi gerekirse yerinde ziyaret planlanır.
Aynı ildeki Ürgüp, Avanos ve Hacıbektaş ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
Sorunu kısa bir notla ve ekran görüntüsüyle WhatsApp'tan iletin; API dokümantasyonu için ön değerlendirme yapalım. Telefon: 0540 003 19 81.
SSSSık sorulan sorular
API dokümantasyonu öncesinde neleri hazırlamalıyım?
Kaynak kod deposu, sunucu ve veritabanı erişimi ve varsa mevcut dokümanlar ve hata kayıtları işi hızlandırır.
REST mi GraphQL mi?
Kaynak bazlı, önbelleğe uygun ve geniş araç desteği gereken çoğu iş API'sinde REST yeterlidir. İstemcilerin çok farklı veri kombinasyonları istediği ürünlerde GraphQL değerlendirilir.
Nevşehir dışındaki işletmelere de hizmet veriyor musunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; İç Anadolu Bölgesi dahil tüm bölgelerde süreç aynı düzenle yürür.
Analiz için sistemime tam erişim vermem gerekir mi?
Gereken erişim işe göre sınırlanır; mümkünse geçici ve yetkisi kısıtlı bir kullanıcı açılması önerilir.
Analiz raporunu başka bir ekip kullanabilir mi?
Evet; rapor bulguları, kanıtları ve önerileri içerdiği için başka bir ekip de uygulamada kullanabilir.
Derinkuyu'dan yazıyorum; toplantılar nasıl yapılıyor?
İşin büyük bölümü uzaktan yürür: ilk görüşme telefonla, sonraki toplantılar görüntülü yapılır. Kurulum ya da eğitim gerekiyorsa yerinde çalışma takvime eklenir.
API dokümantasyonu sırasında site veya uygulama kapanır mı?
Hazırlık test ortamında yapılır; canlı ortamdaki değişiklik önceden haber verilen kısa bir bakım penceresinde uygulanır.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Derinkuyu'da ilgili hizmetler
Nevşehir içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OAuth 2.0
- webhook
- SDK
- Nevşehir
- Derinkuyu