OpenAPI/Swagger ve geliştirici kılavuzu hazırlama.
01Hangi durumlarda gerekir?
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.
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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
02Belirtiler
- Dokümantasyon ve kurulum bilgisinin olmaması
- Kütüphane ve çatı sürümlerinin desteğinin bitmesi
- Hataların tekrar tekrar ortaya çıkması
- Küçük bir değişikliğin başka yerleri bozması
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
NotEski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
06Kapsam
- OpenAPI şeması
- örnek istekler
- kılavuz
Bu projeler çoğu zaman raporlama apı'si, bildirim servisi ve dosya ve medya servisi gibi işlerle birlikte ele alınır.
07Mihalıççık'ta API dokümantasyonu
PTT kayıtlarında Mihalıççık ilçesine bağlı 53 yerleşim bulunur.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Mihalıççık'taki 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.
Eskişehir genelinde Tepebaşı, Beylikova ve Çifteler 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.
08Ekip ve çalışma biçimimiz
Tasarım, geliştirme, test ve yayın adımları aynı ekip içinde yürür. Kod Git ile sürümlenir, kritik akışlar Playwright testleriyle korunur, yayın Docker konteynerleriyle tekrarlanabilir biçimde yapılır.
- Alan adı ve sunucu hesapları işletme adına açılır.
- Her değişiklik önce test ortamında denenir.
- KVKK baştan tasarlanır.
Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz; Eskişehir de bunlardan biri.
SSSSık sorulan sorular
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.
İş 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.
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.
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.
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.
Mihalıççık'tan yazıyorum; toplantılar nasıl yapılıyor?
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.
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.
Sadece Eskişehir için mi çalışıyorsunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; İç Anadolu Bölgesi dahil tüm bölgelerde süreç aynı düzenle yürür.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Mihalıççık'ta ilgili hizmetler
Eskişehir 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
- Swagger
- Eskişehir
- Mihalıççık