Mock API
Mock API, teknik bilgi veya yazılım geliştirme ihtiyacı olmadan kolay ve hızlı bir şekilde REST API ('ler) oluşturmanızı ya da diğer bir ifadeyle API'nın mock'lanmasını sağlayan bir araçtır.
API Dokümantasyonu üzerinden ya da varsayılan CRUD operasyonlarını içeren bir API anında oluşturulup, API Proxy olarak anında kullanıcıların erişimine açılabilirsiniz.
Diğer önemli bir nokta ise; Apinizer, yanıta eklenen koşullar sayesinde, isteğin başlık, gövde ya da parametre değerleri baz alınarak koşula göre farklı yanıtlar alınmasını sağlar.
Oluşturulan Mock API'lerin, Swagger ve OpenAPI türündeki API tanım belgelerine on the fly olarak JSON ve YAML formatında erişilebilir.
Yeni Mock API Oluşturma
Ana menüde Geliştirme → API Oluşturucu → Mock API (Development → API Creator → Mock API) ögesi seçilir.
Açılan arayüzde sağ üstteki +Oluştur tuşuna tıklanır.
Yeni oluşturulacak API için aşağıdaki alanlar doldurularak sağ üstteki →Kaydet ve Devam tuşuna tıklanmasıyla API oluşturma işi başlamış olur.
Blank tipinde Mock API Oluşturma
Bu tipte API oluşturmak, API endpoint'lerinin kullanıcı tarafından tasarlanacağı anlamına gelmektedir.
Eğer Generate CRUD Operations seçeneği aktifleştirilirse, API'ye GET, POST, PUT, DELETE enpoint'leri otomatik olarak eklenmiş olur.
Blank tipinde API oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Open API veya Swagger'dan Mock API Oluşturma
Bu tipte API oluşturmak, API'nın tanım belgesi üzerinden oluşturulacağı anlamına gelmektedir.
İçe aktarılacak ya da linki verilecek API dokümanın tipi Swagger ya da Open API olmalıdır.
Import Spec tipinde API oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Mock API'nın tanımı için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Tip (Type) | Mock API Oluşturma tipidir. Blank ve Spec dosyası yükleyerek yapılır. |
Ad (Name) | API'ye kullanıcı tarafından verilen addır. Arayüzlerde bu ad görünür. |
Açıklama (Description) | API'nin tanım bilgisidir. |
| Generate CRUD Operations | Mock API için GET,POST,PUT ve DELETE tiplerinde hazır metot/endpoint'ler oluşturulması istenirse seçilir. |
API Spec Tipi (API Spec Type) | Yüklenecek Spec dosyasının tür bilgisidir. Desteklenen türler: OpenAPI 3.0.x, Swagger 2.x |
(Import Type) | Yüklenecek Spec dosyasının tür bilgisidir. Desteklenen tipler: URL, Upload File |
| URL | Yüklenecek Spec dosyasının adresi. |
Endpoint Oluşturma
Eğer Generate CRUD Operations seçeneği seçilmişse varsayılan olarak GET, POST, PUT, DELETE tiplerinde metot/endpoint'ler hazır gelecektir. Aşağıdaki gibi Ekle (Add) butonuna tıklayarak yeni metot/endpoint eklenir.
Gelen ekranda Ekle tuşuna tıklayarak API'ye metot/endpoint eklenir.
Method/Endpoint tanımlama ekranındaki alanlar doldurularak Kaydet (Save) tuşuna tıklanır.
Yanıt Ekleme ya da Düzenleme
Yanıt Bilgisi (Response Information) bölümünden metot/endpoint'e ait yanıtlar yönetilir.
Yanıt tanımları, Durum Kodu (Status Code) bilgisine göre gruplandırılarak oluşturulur. Her yanıt tanımı içinde koşul bazlı birden fazla örnek yanıt oluşturulabilir.
Yanıt tanım ayarlarını içeren dialoga ait görsele aşağıda yer verilmiştir:
Yanıt ekleme/düzenleme konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Durum Kodu (Status Code) | HTTP durum kodu bilgisidir. |
Açıklama (Description) | Metot/endpoint'in tanım bilgisidir. |
Başlık (Headers) | HTTP Headers bilgileri girilir. |
Yanıt Örnekleri (Response Examples) | Kullanıcıya gönderilecek olan yanıt örnekleridir. |
Yanıt Örneklerini Ekleme ya da Düzenleme
Bir yanıt tanımına birde fazla gövde ve koşul tanımı oluşturarak örnekler eklenebilir. Böylelikle istek aynı metoda geldiğinde farklı durumlar altında farklı yanıtların istemciye gönderilmesi sağlanabilir.
Örnek Yanıt ayarlarını içeren dialoga ait görsele aşağıda yer verilmiştir:
Örnek Yanıt ekleme/düzenleme konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Yanıt İçerik Tipi (Content Type) | Cevap olarak dönecek gövdenin (body) içerik tipidir. |
Koşul (Condition) | Tanımlanan örnek yanıtın hangi koşul ile karşılaşıldığında döneceğini tanımlamak için kullanılır. |
Yanıt Gövdesi (Response Body) | Kullanıcıya dönecek yanıtın gövdesi (body) yazılır. |
Mock API'den API Proxy Oluşturma
En az bir tane metot/endpoint olduğunda API Proxy Oluştur tuşuna tıklayarak Mock API için bir API Proxy oluşturulur.
Mock API'den API Proxy oluşturmak için en az bir metot/endpoint olmalıdır.
Gelen ekranda API Proxy için gerekli alanları girerek Kaydet butonuna tıklayarak API Proxy oluşturulur.
Bu adımdan sonra yapılabilecekler API Proxy dokümanı ile birebir aynıdır. Detayına gitmek için tıklayınız.
Yükle (Deploy)/Yeniden Yükle (Redeploy)
Mock API'deki API Proxy'leri görüntülemek ve yükleme durumlarını yönetmek için API Proxy'leri Yönet linkine tıklayarak açılan pencere kullanılır.
Açılan pencerede Mock API ile oluşturulan API Proxy'ler Yükle/Kaldır ve Yeniden Yükle işlemleri bu bölümde yapılır. Detayına gitmek için tıklayınız.
API Proxy'i deploy etmek için aşağıdaki adımlar izlenir.
Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yükleme işlemiyle ilgili bilgileri oluşturup (Yükle) Deploy butonuna tıklanır.
Mock API'ye yeni bir endpoint eklendiğinde veya endpoint içinde değişiklik yapıldığında değişikliğin geçerli olabilmesi için bu API'den oluşturulan tüm API Proxy'lerin yeniden yüklenmesi gerekir.
Yeni bir Method/Endpoint eklediğinizde ve ya mevcut bir Metot/Endpoint'i güncellediğinizde aşağıdaki gibi bir bilgilendirme gelecektir.
Yeniden Yükle diyerek değişikliklerin API Proxy'lere uygulanması sağlanır.
Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yeniden yükleme işlemiyle ilgili bilgileri oluşturup (Yeniden Yükle) Redeploy butonuna tıklanır.
Mock API sayfasından API Proxy'nin ismine tıklanarak API Proxy'e gidilir.
Benzer şekilde, API Proxy sayfasından Mock API sayfasına gitmek için aşağıdaki gibi API Proxy'deki Mock API ismine tıklayarak gidilir.
Mock API Silme
Bir Mock API silindiğinden ona bağlı olan tüm API Proxy'ler önce kaldırılır (undeploy) sonra silinir.