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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
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.
02Belirtiler
- Kütüphane ve çatı sürümlerinin desteğinin bitmesi
- Küçük bir değişikliğin başka yerleri bozması
- Hataların tekrar tekrar ortaya çıkması
- Kodu yazan kişiye veya firmaya ulaşılamaması
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 |
04İş 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.
05Kapsam
- OpenAPI şeması
- örnek istekler
- kılavuz
API dokümantasyonu ile birlikte sık planlanan işler arasında raporlama apı'si, bildirim servisi ve dosya ve medya servisi bulunur.
06Develi'de API dokümantasyonu
Develi, Kayseri iline bağlı bir ilçedir ve PTT adres verisine göre 77 mahalleden oluşur.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Develi'deki 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.
Aynı ildeki Sarız, Tomarza ve Yeşilhisar 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.
07Ekip 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.
- Ölçülebilir hedefler konur: arama ve WhatsApp tıklaması, form talebi, işlem süresi.
- Kaynak kod ve veri işletmeye teslim edilir.
- Her değişiklik önce test ortamında denenir.
Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz; Kayseri de 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.
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.
Kayseri dışındaki işletmelere de hizmet veriyor musunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Kayseri de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanı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.
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.
İş 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.
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.
Develi'den 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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu kontrol listesiAdım adım kontrol listesi
- API dokümantasyonu tespit ve analizSorunun nasıl tespit edildiği
- API dokümantasyonu sonrası bakımİşlem sonrası kalıcılık
- API dokümantasyonu sonuçların ölçülmesiHangi metriklerle ölçülür
- API dokümantasyonu sorunları ve belirtileriHangi belirti neyi gösterir
Develi'de ilgili hizmetler
Kayseri 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
- OpenAPI
- Kayseri
- Develi