API Builder oluşturulduktan sonra, ekranda sağ üst köşede bulunan ADD NEW METHOD butonuna tıklayarak yeni bir method tanımlamaya başlayabilirsiniz. Bu adımdan sonra, method için bir isim belirleyebilir ve methodun özelliklerini yapılandırabilirsiniz. Method oluşturma işlemi sırasında ekranın sağında yer alan Properties panelini kullanarak yetkilendirme ve aksiyon ekleme işlemlerini yapabilirsiniz. Oluşturduğunuz methodları istediğiniz zaman silebilir veya yeniden adlandırabilirsiniz.
Properties Panelinde Bulunan Alanlar:
Authorization (Yetkilendirme): API’nin kullanımını yetkilendirme seçenekleri ile belirleyebilirsiniz. Eğer herhangi bir doğrulama istemeden API'nin herkes tarafından kullanılmasını istiyorsanız, Anonymous Access seçeneğini seçebilirsiniz. Ayrıca, tüm rollere açık hale getirmek için All Roles Access seçeneğini de kullanabilirsiniz.
Add Actions (Aksiyon Ekleme): Method çağrıldığında çalışmasını istediğiniz platform aksiyonlarını eklemenizi sağlar. Methodun API üzerinden bir işlem gerçekleştirmesi gerekiyorsa burada aksiyon tanımlayabilirsiniz.
Method Input: Eğer methodunuz belirli bir input değeri alarak çalışacaksa, bu alan üzerinden input özelliklerini tanımlayabilirsiniz. Bu özellikler arasında input adı, tipi gibi detaylar yer alır.
Örnek Senaryo: API Method Yapısının Kullanımı
Örneğin, menü içeriği sunan bir uygulama geliştirdiğinizi varsayalım. Bu uygulamada, bir Barcode numarasını input olarak alıp, durum kodunu (status code) respons olarak döndürmek isteyebilirsiniz.
İlk olarak, UI Design modülünde Custom Actions panelini veya Datasources modülünü kullanarak yeni bir Custom Action oluşturun. Bu Custom Action, bir input alarak sonuç olarak bir durum kodu döndürecektir.
SQL Editör alanına girerek gerekli sorguları yazabilirsiniz. SQL editör, elle yazacağınız sorguları veya yapay zeka yardımı ile oluşturulan sorguları kabul eder. Örneğin, aşağıdaki sorguyu ekleyebilirsiniz:
SELECT Barcode, Status FROM Menu WHERE Barcode =@Barcode
Aksiyonunuza bir isim (örneğin, Status Inquiry) verin ve CREATE butonuna tıklayın. Bu aksiyonu API Method içine çağırmak için +ADD ACTION butonuna tıklayın ve açılan arama çubuğuna Status Inquiry yazarak aksiyonu ekleyin.
Oluşturulan aksiyonun parametresini Symbol Picker aracılığıyla Action Results → Status Inquiry olarak tanımlayın.
SQL Editör içinde “@” ile belirttiğiniz Barcode parametresi, dışarıdan bir method input olarak API’ye açılmalıdır. Bunun için +ADD METHOD INPUT butonuna tıklayın, Input Name alanına Barcode yazın, input tipini Guid olarak belirleyin ve Create butonuna tıklayın.
Oluşturduğunuz aksiyon, dışarıdan parametre alıp SQL sorgularını yürütmeye hazır hale gelir. Tüm yapılandırmaları test etmek için Preview butonuna tıklayın. Önizleme sonucunda URL kısmında Swagger yazısına tıklayarak API’niz ve eklenen method işlemlerini görüntüleyebilirsiniz. Bu işlemlerin yalnızca oturum açmış kullanıcılar tarafından mı, yoksa herkes tarafından mı görüntülenebileceğini Properties panelindeki Authorization alanından ayarlayabilirsiniz.
