OpenAPI/Swagger ve geliştirici kılavuzu hazırlama.
01Hangi durumlarda gerekir?
Entegrasyon talepleri tek tek karşılandığında
Standart bir API ve dokümantasyon, her iş ortağı için ayrı geliştirme yapma ihtiyacını azaltır.
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.
02Belirtiler
- Küçük bir değişikliğin başka yerleri bozması
- Dokümantasyon ve kurulum bilgisinin olmaması
- Kütüphane ve çatı sürümlerinin desteğinin bitmesi
- Hataların tekrar tekrar ortaya çıkması
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 sistemlerde uygulanır?
- Yazılım şirketleri
- Veri sağlayıcıları
- Platform kuran girişimler
- Kurumsal BT ekipleri
- İş ortağı ekosistemi olan firmalar
05İş nasıl ilerler?
- Kod, erişimler ve ortamlar üzerinde durum tespiti yapmak
- Riskleri ve öncelikleri listelemek
- Test ortamı ve sürüm kontrolünü düzene sokmak
- Kritik hataları ve güvenlik açıklarını gidermek
- Testleri ve dokümantasyonu tamamlamak
- Düzenli bakım ve geliştirme planına geçmek
NotAnahtarların sızıntıya karşı taranması ve yenilenmesi planlanır.
06Kapsam
- OpenAPI şeması
- örnek istekler
- kılavuz
İhtiyaca göre raporlama apı'si, bildirim servisi ve dosya ve medya servisi da aynı yol haritasına eklenebilir.
07Keban'da API dokümantasyonu
Keban'ın PTT verisindeki 77 yerleşim kaydı 2 farklı posta koduna dağılır.
Mesafe yazılım işinin önünde engel değildir: Keban'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.
Aynı ildeki Maden, Palu ve Alacakaya ilçeleri için de API dokümantasyonu talepleri değerlendirilir; 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.
08Nasıl çalışıyoruz?
Projeler tasarım, yazılım geliştirme, test ve yayın adımlarını kapsayan bir ekiple yürütülür. Sürüm kontrolü (Git), otomatik testler (Playwright), konteyner tabanlı yayın (Docker), sürekli entegrasyon ve izleme araçları standart çalışma düzenimizin parçasıdır.
- Ölçülebilir hedefler konur: arama ve WhatsApp tıklaması, form talebi, işlem süresi.
- Yayın sonrası bakım ve destek planlanır.
- Kaynak kod ve veri işletmeye teslim edilir.
Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz; Elazığ da bunlardan biri.
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.
İş sırasında site 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.
Keban'da yüz yüze görüşebilir miyiz?
İş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.
Sadece Elazığ için mi çalışıyorsunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Elazığ 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.
Ne kadar sürer?
Süre işin kapsamına ve erişimlerin hazır olmasına göre değişir; ön değerlendirmeden sonra planlı bir takvim paylaşılır.
Uzaktan yapılabilir mi?
Çoğu teknik iş uzaktan, verilen erişimlerle yapılır; donanım veya yerinde kurulum gereken işler ayrıca planlanır.
API'yi kimlerin kullandığını nasıl izleriz?
Her istemciye ayrı anahtar veya OAuth istemcisi verilir; kullanım, hata ve kota tüketimi istemci bazında raporlanı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: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonu tespit ve analizSorunun nasıl tespit edildiği
- API dokümantasyonu kontrol listesiAdım adım kontrol listesi
- API dokümantasyonu sorunları ve belirtileriHangi belirti neyi gösterir
Keban'da ilgili hizmetler
Elazığ içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- webhook
- SDK
- Elazığ
- Keban