Uygulamanız ya da siteniz için yazılmış bir API
Uygulamanızın ya da sitenizin kullandığı API'yi, ön yüz ekibinizle bir API sözleşmesinde anlaşarak kuruyoruz; arayüz o ekipte kalıyor.
Kimin için
İlerlemek için back-end'i bekleyen bir uygulama ya da ön yüz ekibi olan şirketler için.
Neyi çözer
- Bir ekran için birkaç ayrı API çağrısı yapılıyor, sonuçlar telefonda birleştiriliyor.
- Back-end bir alanı değiştiriyor, canlıdaki uygulama bozuluyor.
- Ön yüz ekibi API hazır olsun diye bekliyor, iş ilerlemiyor.
- Uygulamanın eski sürümleri hâlâ telefonlarda; neyi çağırdıklarını kimse bilmiyor.
Ne yapıyoruz
- API sözleşmesi
- Uç noktalar, alanlar ve hatalar, kod yazılmadan önce ön yüz ekibiyle OpenAPI ya da GraphQL'de kararlaştırılır.
- Mock sunucu
- Gerçek API yazılırken ön yüz ekibi örnek yanıtlarla çalışmayı sürdürür.
- Ekrana göre katman (BFF)
- Birden çok kaynağı toplayıp her ekrana yalnız ihtiyaç duyduğunu döndüren bir katman.
- Üretilen tipler
- TypeScript, Kotlin ya da Swift tipleri sözleşmeden üretilir; uygulama biçim tahmin etmek zorunda kalmaz.
- Sürümleme
- Geriye uyumsuz değişiklik yeni sürüme girer; uygulamanın eski sürümleri kararlaştırılan süre boyunca çalışır.
- Sözleşme testleri
- Her yayında sözleşmenin hâlâ geçerli olduğu otomatik testlerle denetlenir.
Neler teslim edilir
- Ön yüz ekibinizle gözden geçirilmiş, sürümlü API sözleşmesi
- Ön yüzün paralel çalışabilmesi için mock sunucu
- Kimlik doğrulaması ve kullanım limitleriyle canlıda çalışan API
- Uygulamanızın dilleri için sözleşmeden üretilmiş tipler
- Her yayında koşan sözleşme testleri
Nasıl ilerliyoruz
Ekranlar ve akışlar
Ekibinizin zaten tasarladığı ekranlardan ve akışlardan yola çıkarız.
Sözleşme
Uç noktalar, alanlar ve hatalar yazıya dökülür, iki taraf da onaylar.
Paralel geliştirme
Ön yüz mock sunucuyla çalışırken back-end gerçek sözleşmeyi uygular.
Entegrasyon
Uygulama, test ortamında mock sunucudan gerçek API'ye geçer.
Canlıya geçiş
API, uygulamanın yeni sürümüyle birlikte ve geri dönüş planıyla yayına girer.
Teknoloji örnekleri
- OpenAPI
- GraphQL
- TypeScript
- Node.js
- Pact
- Redis
İlgili hizmetler
Sık sorulan sorular
Henüz bir ön yüz ekibimiz yoksa?
Balkan arayüzü ve uygulamayı yapmaz, mağazalara da yüklemez. Bu durumda şirketiniz bu işi yapacak bir ekiple anlaşır; biz de en başından API sözleşmesi üzerinden o ekiple çalışırız.
Ekranlar için neden ayrı bir katman?
Her ekran tek bir çağrı yapsın ve yalnız ihtiyaç duyduğu veriyi alsın diye. Uygulama küçükse ve mevcut API yetiyorsa ek katman zahmetine değmeyebilir; bu, sözleşmede kararlaştırılır.
Uygulamamız var ve başka bir API'yle konuşuyor. Ne olacak?
Mevcut API'nin önüne yeni bir katman konup ekran ekran geçilebilir; bütün kullanıcıları uygulamayı aynı anda güncellemeye zorlamak gerekmez.
Başlamak için neyin hazır olması gerekir?
Ana akışların ekranları ya da prototipleri ve sözleşmeyi gözden geçirecek bir ön yüz ekibi üyesi. Gerisi haritalamada belirlenir.
Balkan'a yazın
Projeniz için yazın