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.
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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
02Belirtiler
- 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ı
- Dokümantasyon ve kurulum bilgisinin olmaması
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
Bu projeler çoğu zaman raporlama apı'si, bildirim servisi ve dosya ve medya servisi gibi işlerle birlikte ele alınır.
07Dikmen'de API dokümantasyonu
Dikmen, Sinop iline bağlı bir ilçedir ve PTT adres verisine göre 160 mahalle ve köy kaydından oluşur.
Mesafe yazılım işinin önünde engel değildir: Dikmen'deki 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.
Sinop genelinde Boyabat, Gerze ve Erfelek 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
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.
- Her değişiklik önce test ortamında denenir.
- Yayın sonrası bakım ve destek planlanır.
Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz; Sinop da bunlardan biri.
SSSSık sorulan sorular
Sinop dışındaki işletmelere de hizmet veriyor musunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Sinop de bunlardan biridir. Yerinde iş gerektiğinde ziyaret 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.
Dikmen'de bulunuyorum, yerinde görüşme mümkün mü?
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.
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.
İş 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
Dikmen'de ilgili hizmetler
Sinop içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OpenAPI
- webhook
- Sinop
- Dikmen