01Sık yapılan hatalar
Test ortamı olmadan canlıda düzeltme yapmak
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
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
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
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
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ı
- OpenAPI dokümantasyonu
- oran sınırı ve kota
- sürümleme stratejisi
05İşletim ve bakım ipuçları
- Dokümantasyon her sürümle birlikte güncellenir.
- Webhook teslim hataları ve yeniden denemeler raporlanır.
- Anahtarların sızıntıya karşı taranması ve yenilenmesi planlanır.
06İnhisar'da destek
İnhisar'ın PTT verisindeki 14 yerleşim kaydı 2 farklı posta koduna dağılır.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; İnhisar'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.
Bilecik genelinde Bozüyük, Bilecik Merkez ve Söğüt 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.
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.
Sadece Bilecik için mi çalışıyorsunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Bilecik de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanır.
İnhisar'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.
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.
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.
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
İnhisar'da ilgili hizmetler
Bilecik içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OpenAPI
- OAuth 2.0
- Bilecik
- İnhisar