01Sık yapılan hatalar
Test ortamı olmadan canlıda düzeltme yapmak
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
Hatayı yeniden üretmeden kod değiştirmek
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
Sürüm kontrolü kullanmamak
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
Tüm sistemi aynı anda yeniden yazmaya kalkmak
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
Yapılan değişiklikleri belgelememek
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
02Doğru yaklaşım
- Önce yedek, sonra tespit
- Değişiklikleri test ortamında denemek
- Her adımı kayıt altına almak
- Sonucu ölçümle doğrulamak
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 |
04Planlama notları
- oran sınırı ve kota
- sürümleme stratejisi
- kimlik doğrulama (API anahtarı, OAuth 2.0)
05API dokümantasyonu hangi işletmelerde kullanılır?
- Platform kuran girişimler
- Yazılım şirketleri
- Kurumsal BT ekipleri
- İş ortağı ekosistemi olan firmalar
06Hangi durumlarda gündeme gelir?
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
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.
07Armutlu'da destek
PTT kayıtlarında Armutlu ilçesine bağlı 11 yerleşim bulunur: 3 mahalle ile 8 köy ve köy yerleşimi.
Mesafe yazılım işinin önünde engel değildir: Armutlu'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.
Yalova genelinde Altınova, Termal ve Çınarcık gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.
Siteniz veya uygulamanız çalışmıyorsa hemen arayın: 0540 003 19 81 — önce yedek, sonra tespit.
SSSSık sorulan sorular
Yalova dışındaki işletmelere de hizmet veriyor musunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; Marmara Bölgesi dahil tüm bölgelerde süreç aynı düzenle yü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.
Armutlu'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.
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.
En pahalıya mal olan hata hangisi?
Yedeksiz müdahale; geri dönüşü olmayan veri kaybı en maliyetli sonuçtur.
Bir hata yaptım, ne yapmalıyım?
Daha fazla değişiklik yapmadan mevcut durumu kaydedin, yedeğiniz varsa saklayın ve uzmana ulaşın. Acil durumlar için ayrı bir kontrol listesi hazırladık.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu tespit ve analizSorunun nasıl tespit edildiği
- API dokümantasyonu sonrası bakımİşlem sonrası kalıcılık
- API dokümantasyonu fiyatlarıMaliyeti belirleyenler
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonuTespit, uygulama ve teslim
Armutlu'da ilgili hizmetler
Yalova 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
- SDK
- Swagger
- Yalova
- Armutlu