Projeler
Bir projenin işlevi, bir grup API'nin tasarlama, yayınlama, geliştirme ve analiz etme ile ilgili tüm varlıklarını gruplandırarak yönetmektir.
Bu yüzden proje yapısı, Apinizer'ın en önemli yapılarından biridir.
Bir amaç çatısı altında kategorize edilen API Proxy'ler ve onunla ilişki bağlantılar ve konfigürasyonlar, API yaşam döngüsüne ait yönetimi kolay hale getirir.
Apinizer, ilk kurulumda bir Varsayılan (default) proje sağlar. Bu Varsayılan proje düzenlenemez veya silinemez.
Proje tanımı yapıldıktan sonra genel olarak, rollerine göre üyeler tanımlanır. Üye tanımlama hakkında detaylı bilgi almak için tıklayınız.
Proje Oluşturma
Apinizer'da bulunan bütün projeler, Yönetim → Projeler ekranından görüntülenebilir veya yeni bir proje oluşturulabilir.
Bir proje iki şekilde oluşturulabilir:
- Yeni (Create) butonu ile yeni bir proje tanımlaması yapılabilir.
- Proje Yükle (Import Project) linkine tıklanarak mevcut bir proje konfigürasyon dosyası üzerinden bir proje yüklenerek oluşturulabilir.
Proje listesini içeren görsele aşağıda yer verilmiştir:
Eğer Project Owner rolüne sahip kullanıcı o projeden silinirse; Admin kullanıcısı o proje için Project Owner olur.
Proje ayarlarını içeren görsele aşağıda yer verilmiştir:
Proje konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
| Alan | Açıklama |
|---|---|
| Dosya Yükleme (Project) | Bu alan, "Dosya Yükleme" linki ile mevcut bir projenin dışa aktarılmış halinin yeni bir proje olarak içe aktarılacağı zaman ekranda gözükür olur ve içe aktarılacak .zip dosyasının yüklenmesi için kullanılır. |
| Ad | Oluşturulan proje için proje adı bilgisidir. |
| Geçit Adresi'ni Aktive Et (Enable Relative Path) | Proje içerisinde yer alan tüm geçit adreslerinde ortak bir ön-ek kullanılmak isteniyorsa aktif hale getirilir. |
| Geçit Adresi (Relative Path) | Projenin içinde tanımlanacak tüm Geçitlerin geçit adreslerin başlayacağı ön-ek ifadesi bu alana girilir. Sistem tarafından otomatik bir UUID verilir. Örneğin; proje geçit adresi "account" olduğu durumda API proxy geçit adresi şu şekilde gözükür: /account/proxy1 |
| Açıklama | Oluşturulan proje ile ilgili yönetimi kolaylaştırmak için açıklama yazılabilir. |
| Etiketler (Tags) | Projeyi kategorize etmek için (örneğin birim veya kurum adına göre) birden fazla etiket eklenebilir. Serbest metin olarak yazılır, her etiketten sonra Enter'a basılarak eklenir. |
Ekranın üst kısmında yer alan proje seçim penceresinde de projeler; ad, açıklama ve etiketlere göre filtrelenebilir. Listede her projeye ait etiketler görüntülenir.
Proje İçe Aktarma Nasıl İlerler
Bir proje paketini içe aktardığınızda işlem arka planda çalışır. Proje Yükle ekranında İçe Aktar düğmesine bastıktan sonra ekranda bir ilerleme göstergesi ve "İçe aktarma arka planda çalışıyor" bilgisi görünür; sonuç hazır olduğunda ekran kendiliğinden güncellenir.
Paket bütünlüğü, arka plan işi başlamadan önce denetlenir. Paket dışa aktarıldığı hâlinden farklıysa ekranda "paket değiştirilmiş, yine de içe aktarılsın mı" onayı sorulur; onaylamazsanız içe aktarma hiç başlamaz ve listede yeni bir proje oluşmaz. Onaylarsanız işlem her zamanki gibi arka planda sürer.
İçe aktarma başarıyla tamamlanırsa başarı mesajı gösterilir ve proje listesine dönülür; yeni proje listede yer alır.
İçe aktarma başarısız olursa ekranda başarısızlığın nedeni gösterilir ve aynı sayfada kalırsınız; paketi düzeltip yeniden deneyebilirsiniz. Başarısız bir içe aktarma geriye yarım bir proje bırakmaz: işlem sırasında oluşturulmuş kayıtlar geri alınır, dolayısıyla proje listesinde kullanılamaz durumda bir proje oluşmaz.
Proje dışa aktarma paketi projenin tüketicilerini (consumer) de içerir ve tüketici kullanıcı adları tüm kurulum genelinde tekildir. Bu nedenle bir projeyi aynı kuruluma yeniden içe aktarmak — ya da bu kullanıcı adlarından birini zaten barındıran bir kuruluma aktarmak — "tüketici kullanıcı adı zaten var" gerekçesiyle reddedilir ve proje oluşmaz. Proje bütününü içe aktarmada tüketiciler için yeniden kullan/değiştir seçeneği yoktur: dışa aktarmadan önce çakışan tüketicileri kaynakta kaldırın ya da yeniden adlandırın, tüketici kayıtlarını paketten çıkarın veya projenin varlıklarını mevcut tüketiciyi yeniden kullanabilen Export/Import Sihirbazı ile tek tek taşıyın.
Proje Yükle ekranındaki Çakışan tüketicileri atla kutusu bu ret davranışına bir alternatif sunar. Varsayılan olarak kapalıdır; kapalıyken içe aktarma yukarıda anlatıldığı gibi çalışmaya devam eder — çakışan bir tüketici varsa hiçbir şey yazılmadan reddedilir.
Kutu işaretlenirse çakışan tüketiciler projeye alınmaz, paketin geri kalanı normal şekilde içe aktarılır. Atlanan bir tüketiciye bağlı nesneler (API istemcisi, limit ataması, erişim yetkisi) de tüketiciyle birlikte dışarıda bırakılır — sahipsiz, yarım bir kayıt oluşmaz. İçe aktarma tamamlandığında başarı mesajından önce sarı bir uyarı çıkar; bu uyarı atlanan tüketicilerin ve varsa onlarla birlikte bırakılan nesnelerin adlarını listeler. Aynı bilgi Uygulama Logları'na da INFO satırı olarak yazılır.
Tüketici kullanıcı adlarının kurulum genelinde tekil olması kuralı bu seçenekle değişmez; kutu yalnızca çakışan tüketicilerin projeye dahil edilip edilmeyeceğini belirler.
İçe aktarma sürerken sayfadan ayrılabilirsiniz. İşlem sunucuda çalışmaya devam eder; sonucu Yönetim → Projeler listesinden görebilirsiniz — proje listede görünüyorsa içe aktarma tamamlanmıştır.