OutSystems ile REST API İşlemleri

REST (Representational State Transfer) API, bir web servisini kullanarak farklı sistemler arasında veri ve işlemlerin paylaşılmasını sağlayan bir yöntemdir. OutSystems Projelerinizde kolaylıkla bu yöntemi kullanarak geliştirilen bir web servisi oluşturabilir ve bu servisi kolaylıkla diğer sistemlerle entegre edebilirsiniz.

OutSystems Service Studio üzerinden bir REST API’a bağlanarak GET, POST, PUT, DELETE ve PATCH metotlarını kullabilirsiniz.

Öncelikle projemize bir REST API consume ederek başlayacağız. Bunun için Logic sekmesi aldında REST’e sağ tıklayıp Consume REST API… seçeneğini seçiyoruz.

Burada karşımıza iki adet seçenek çıkacak. Add single method diyerek tek bir metot ekleyebilirsiniz veya add multiple methods seçeneğini seçerek Swagger.json dosyasına sahip bir apiyi içeriye aktarabilirsiniz. Bu işlemi yaparak tüm API isteklerimizi hızlıca içeri aktarabiliriz. OutSystems ile oluşturduğunuz REST API’ler bu özelliğe sahiptir.

Soldaki seçeneği seçerek devam ettiğimizde bizden API’nin beklediği methodu ve REST API URL’sini girmemizi beklemektedir. Eğer URL bir parametre alıyor iste küme parantezleri arasında ({parametre_adı}) ekleyebilirsiniz. Örnek: https://api.example.com/?q={query}.

Metodu seçtikten ve API Urlsini girdikten sonra Test sekmesine geliyoruz. Eğer query girdiysek bu sekmede gözükecek inputa bir test parametresi giriyoruz ve test butonuna basıyoruz. İşlem tamamlandıktan sonra Copy to response body seçeneği ile örnek responsemizi body ye aktarıyoruz.

Bu işlemi tamamladıktan sonra finish butonuna basabilirsiniz. REST API’miz Logic altında REST kısmına eklenecektir. Üzerine tıklayarak ismi, iconu gibi bazı bilgileri düzenleyebilirsiniz.

Eğer data tabı altındaki structures bölümüne baktığımızda OutSystems’in bizim için otomatik olarak gerekli structuresları oluşturduğunu görebilirsiniz.

Eğer isterseniz structures bilgilerini güncelleyebilirsiniz. Zorunlu bir adım değildir.

Oluşturduğunuz REST APInin üzerisine sağ tıklayarak yeni metotlar ekleyebilirsiniz.

Yukarıda GET metodu için işlemlerimizi gerçekleştirmiştik. Eğer POST, PUT, DELETE ve PATCH’e bakarsak GET’den farklı olarak Body kısmında response’ye ek olarak request seçeneğinin geldiğini görebilirsiniz. Buraya eğer REST API’ye bir veri göndermemiz gerekiyorsa Örnek JSON olarak giriş yapmamız gerekiyor.

Oluşturduğumuz REST API’yi projemizde kullanmak istediğimiz zaman Client ve Server actionlar içerisinde çağırarak istediğiniz şekilde kullanabilirsiniz. Sayfa içerisinde çekmek istediğimizde iste Traditional Projelerde Bir Preperation ekliyoruz ve içerisinde REST API’nin bizim için oluşturduğu actionı çağırıyoruz. Reactivede ise iş biraz farklı.

Reactive Projemizde kullanabilmek için öncelikle kullanmak istediğimiz ekranımıza sağ tıklıyoruz ve Fetch Data From Other Sources seçeneğini seçiyoruz.

Bizim için bir output değişkeni olan flow açacaktır burada ilk olarak output değişkenimizin data type’ını REST API’nin bizim için oluşturduğu structure olarak ayarlamamız gerekiyor.

Daha sonrasında flowumuzda REST API actionını çağırıyoruz. Bizim için döndüğü değeri Output değişkenimize tanımlıyoruz.

Daha sonrasında istediğiniz yerde datalarınızı kullanabilirsiniz.