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.
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.
02Belirtiler
- Kodu yazan kişiye veya firmaya ulaşılamaması
- 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.
07Uğurludağ'da API dokümantasyonu
Uğurludağ'ın PTT verisindeki 25 yerleşim kaydı 2 farklı posta koduna dağılır.
Mesafe yazılım işinin önünde engel değildir: Uğurludağ'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 Sungurlu, Osmancık ve Çorum Bayat 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.
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.
- Her değişiklik önce test ortamında denenir.
- Ölçülebilir hedefler konur: arama ve WhatsApp tıklaması, form talebi, işlem süresi.
- KVKK baştan tasarlanır.
Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz: görüntülü toplantı, ekran paylaşımlı demo ve ortak proje panosu. Donanım kurulumu, depo barkod sistemi kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.
SSSSık sorulan sorular
Uğurludağ'da bulunuyorum, yerinde görüşme mümkün mü?
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.
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.
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.
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.
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.
Sadece Çorum için mi çalışıyorsunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; Karadeniz Bölgesi dahil tüm bölgelerde süreç aynı düzenle yü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.
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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Uğurludağ'da ilgili hizmetler
Çorum içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- rate limit
- Swagger
- webhook
- Çorum
- Uğurludağ