Efeler, Aydın: API Dokümantasyonu Sık Yapılan Hatalar

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

Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.

Sürüm kontrolü kullanmamak

Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.

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

Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.

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

04Hangi 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.

05Efeler'de destek

Efeler'in PTT verisindeki 84 yerleşim kaydı 4 farklı posta koduna dağılır. Bu kayıtlardan 1 tanesi organize sanayi veya serbest bölge kaydıdır. Birden fazla ilçede ekibi veya şubesi olan işletmelerde API dokümantasyonu için kullanıcı rolleri, şube bazlı görünürlük ve merkezi raporlar birlikte planlanır.

Mesafe yazılım işinin önünde engel değildir: Efeler'deki 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.

Aydın genelinde Didim, Söke ve Kuyucak gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.

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.

Hemen ara WhatsApp Teklif formu

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.

Efeler'den yazıyorum; toplantılar nasıl yapılıyor?

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.

Aydın dışındaki işletmelere de hizmet veriyor musunuz?

Askadar Yazılım 81 ilde uzaktan çalışır; Aydın de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanır.

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.

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 ö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

Efeler'de ilgili hizmetler

Aydın içindeki diğer ilçeler

Genel sayfalar

Bu sayfada geçen kavramlar

OpenAPI şeması
örnek istekler
kılavuz
API anahtarı
geliştirici portalı
SSO
rate limit
OAuth 2.0
Aydın
Efeler

API dokümantasyonu sırasında sık yapılan hatalar (Efeler)