01Sık yapılan hatalar
Test ortamı olmadan canlıda düzeltme yapmak
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
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
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
Yapılan değişiklikleri belgelememek
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
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ı
- webhook imza doğrulaması
- OpenAPI dokümantasyonu
- oran sınırı ve kota
05Diyarbakır'da destek
Güneydoğu Anadolu Bölgesi illerinden Diyarbakır (plaka 21), PTT adres verisinde 17 ilçe ve 1.057 yerleşim kaydıyla yer alır. Diyarbakır büyükşehir belediyesi olan 30 ilden biridir. Büyükşehirlerde merkez ve şube yapısıyla çalışan işletmeler için API dokümantasyonu tasarımında merkez-şube yetki yapısı ve birleşik raporlama öne çıkar.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Diyarbakır'daki işletmelerle ekran paylaşımlı demolar ve ortak bir proje panosu üzerinden çalışılır. Donanım kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.
Güneydoğu Anadolu Bölgesi'ndeki Şanlıurfa, Gaziantep ve Siirt gibi illerdeki işletmelerle de 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
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.
Sadece Diyarbakır için mi çalışıyorsunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Diyarbakır de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanı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.
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.
Diyarbakır'da yüz yüze görüşebilir miyiz?
Toplantılar görüntülü yapılır ve ekran paylaşımıyla ilerler. Cihaz kurulumu, saha incelemesi veya ekip eğitimi gibi yerinde bulunmayı gerektiren adımlar ayrıca planlanı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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu öncesi hazırlıkErişimler, yedek ve hazırlık
- API dokümantasyonu nasıl yapılırAdım adım uygulama
- API dokümantasyonuTespit, uygulama ve teslim
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonu tespit ve analizSorunun nasıl tespit edildiği
Diyarbakır'da ilgili hizmetler
Güneydoğu Anadolu Bölgesi'ndeki diğer iller
Diyarbakır ilçelerinde API dokümantasyonu sık yapılan hatalar
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OAuth 2.0
- Swagger
- Diyarbakır