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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
02Belirtiler
- Dokümantasyon ve kurulum bilgisinin olmaması
- Kodu yazan kişiye veya firmaya ulaşılamaması
- Kütüphane ve çatı sürümlerinin desteğinin bitmesi
- Hataların tekrar tekrar ortaya çıkması
03Hangi sistemlerde uygulanır?
- Yazılım şirketleri
- Veri sağlayıcıları
- Platform kuran girişimler
- Kurumsal BT ekipleri
- İş ortağı ekosistemi olan firmalar
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
NotEski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
05Kapsam
- 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.
06Dalaman'da API dokümantasyonu
Dalaman, Muğla iline bağlı bir ilçedir ve PTT adres verisine göre 25 mahalleden oluşur.
Mesafe yazılım işinin önünde engel değildir: Dalaman'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 Marmaris, Ortaca ve Yatağan 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.
07Çalışma düzenimiz
Çalışma düzenimizde sürüm kontrolü, otomatik testler, konteyner tabanlı yayın ve izleme araçları standarttır; her değişiklik bu adımlardan geçerek canlıya çıkar.
- Kaynak kod ve veri işletmeye teslim edilir.
- Her değişiklik önce test ortamında denenir.
- Alan adı ve sunucu hesapları işletme adına açılır.
Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz; Muğla da bunlardan biri.
08Örnek hesap
Örnek: otomasyonla kazanılan süre
- Günlük tekrarlanan iş
- 167
- İş başına süre
- 5 dk
- Aylık süre (22 iş günü)
- 306,2 saat
- Otomasyon sonrası doğrulama payı (%13)
- 39,8 saat
Not: örnek hesaptır; kesin plan analizde çıkar.
SSSSık sorulan sorular
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.
İş 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.
Sadece Muğla 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.
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.
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.
Dalaman'dan 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.
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.
→İ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 sık yapılan hatalarKaçınılması gerekenler
- API dokümantasyonu sorunları ve belirtileriHangi belirti neyi gösterir
Dalaman'da ilgili hizmetler
Muğla 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
- SDK
- OAuth 2.0
- Muğla
- Dalaman