01Adımlar
1. Kod, erişimler ve ortamlar üzerinde durum tespiti yapmak
Gerekirse bu adım test ortamında önceden denenir.
2. Riskleri ve öncelikleri listelemek
Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.
3. Test ortamı ve sürüm kontrolünü düzene sokmak
Gerekirse bu adım test ortamında önceden denenir.
4. Kritik hataları ve güvenlik açıklarını gidermek
Bu adımın çıktısı kısa bir notla paylaşılır.
5. Testleri ve dokümantasyonu tamamlamak
Bu adımın çıktısı kısa bir notla paylaşılır.
6. Düzenli bakım ve geliştirme planına geçmek
Bu adımın çıktısı kısa bir notla paylaşılır.
02Dikkat noktaları
- Kaçınılması gereken: test ortamı olmadan canlıda düzeltme yapmak
- Kaçınılması gereken: sürüm kontrolü kullanmamak
- Kaçınılması gereken: tüm sistemi aynı anda yeniden yazmaya kalkmak
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 |
04Defne'de API dokümantasyonu
Defne, Hatay iline bağlı bir ilçedir ve PTT adres verisine göre 37 mahalleden oluşur. 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.
Defne'de bulunan bir işletmeyle çalışırken toplantılar görüntülü yapılır, her aşama test ortamında paylaşılır ve geri bildirimler ortak panoda toplanır; yerinde bulunmak gereken kurulum ve eğitim adımları ayrıca planlanır.
Hatay genelinde İskenderun, Arsuz ve Erzin 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.
05İşletim ve bakım ipuçları
- Dokümantasyon her sürümle birlikte güncellenir.
- Hata oranı ve yanıt süresi uç nokta bazında izlenir.
- Anahtarların sızıntıya karşı taranması ve yenilenmesi planlanır.
06Örnek kapsam hesabı
Örnek: otomasyonla kazanılan süre
- Günlük tekrarlanan iş
- 162
- İş başına süre
- 9 dk
- Aylık süre (22 iş günü)
- 534,6 saat
- Otomasyon sonrası doğrulama payı (%18)
- 96,2 saat
Not: örnek hesaptır; kesin plan analizde çıkar.
SSSSık sorulan sorular
Bu adımları kendim uygulayabilir miyim?
Bazı adımlar teknik bilgiyle yapılabilir; yedekleme, sürüm uyumu ve canlı ortam değişiklikleri ise deneyim gerektirir. Kendin yap mı uzman mı sayfasında ayrımı anlattık.
Adımların sırası değişebilir mi?
Mevcut duruma göre değişebilir; ancak yedek ve test adımları her zaman önce gelir.
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.
Defne'de yüz yüze görüşebilir miyiz?
Analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; donanım kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.
Sadece Hatay için mi çalışıyorsunuz?
Evet. Askadar Yazılım, Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışır; gerektiğinde yerinde çalışma ayrıca 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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu tespit ve analizSorunun nasıl tespit edildiği
- API dokümantasyonu sorunları ve belirtileriHangi belirti neyi gösterir
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonu sonrası bakımİşlem sonrası kalıcılık
- API dokümantasyonu kontrol listesiAdım adım kontrol listesi
Defne'de ilgili hizmetler
Hatay 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
- Hatay
- Defne