API Creator ile Scriptten API oluşturma

Çalışma Mantığı

Apinizer gelen mesajın öğelerini (başlık, parametre, gövde) seçilen script diliyle işler. Sonucu istemciye gönderir.

Okuma ve Yazma Kuralları

Script gelen isteğin orijinal halini değiştiremez. Script bu verileri yalnız okur. İstemciye dönecek yanıtı script hazırlar.

Script-2-API Listesi

Ana menüde Geliştirme → API Oluşturucu → Script-2-API (Development → API Creator → Script-2-API) öğesini seçin. Liste tek bir kartta açılır. Sayfa Mock API listesiyle aynı düzendedir.

Kartın üst bölümünde bir arama kutusu ve aramayı temizleyen bir düğme bulunur. Listeyi süzmek için arama kutusuna bir ad yazın.

Sütun	Açıklama
Ad (Name)	Script-2-API'nin adı. Adın altında açıklaması görünür. Düzenleyiciyi açmak için ada tıklayın.
Uç Noktalar (Endpoints)	Script-2-API'deki uç nokta sayısı.
Diller (Languages)	Uç noktaların script dilleri. Örneğin: JS · GROOVY.

Her satırın sonunda bir ⋮ menüsü bulunur. Menüde şu seçenekler yer alır:

Seçenek	Ne yapar
Düzenleyiciyi aç (Open editor)	Script-2-API'yi düzenleyicide açar.
Çoğalt (Duplicate)	Script-2-API'nin kopyasını oluşturur. Açılan pencerede kopya için bir ad girin.
Dışa Aktar (Export)	Dışa/İçe Aktarma Sihirbazı'nı bu Script-2-API için açar.
Sil (Delete)	Script-2-API'yi siler. Ayrıntılar için Script-2-API Silme bölümüne bakın.

Sayfanın sağ üstünde iki düğme bulunur:

• Veriyi Aktar (Import): Dışa/İçe Aktarma Sihirbazı'nı API Creator tipiyle açar. Dışa Aktar ile aldığınız bir dosyayı içe aktarır. Ayrıntılar için Export Import sayfasına bakın.
• + Yeni (Create): Script API Oluştur penceresini açar. Ayrıntılar için Yeni Script-2-API Oluşturma bölümüne bakın.

Yeni Script-2-API Oluşturma

Menüden Script-2-API Sayfasına Gidin

Ana menüde Geliştirme → API Oluşturucu → Script-2-API öğesini seçin.

Yeni API Oluşturun

Sağ üstteki + Yeni düğmesine tıklayın. Script API Oluştur penceresi açılır.

API Bilgilerini Doldurun

API'nin adını ve açıklamasını girin. İlk uç nokta bölümünde ilk uç noktayı tanımlayın. Sonra Yeni düğmesine tıklayın. Apinizer Script-2-API'yi bu uç nokta ve bir başlangıç script'iyle kaydeder. Sonra düzenleyiciyi açar.

Uç Nokta Ekleyin

Başka bir uç nokta eklemek için düzenleyicide API Uç Noktaları başlığının yanındaki + düğmesine tıklayın. Script-2-API'de hiç uç nokta yoksa orta bölümdeki Ekle düğmesine de tıklayabilirsiniz.

Script API Oluştur penceresinde şu alanlar bulunur:

Alan	Açıklama
Ad (Name)	Zorunlu. Script-2-API'nin adı. Apinizer adın benzersiz olup olmadığını denetler.
Açıklama (Description)	Script-2-API'nin kısa açıklaması.
HTTP Metot (HTTP Method)	İlk uç noktanın metodu.
Yol (Path)	İlk uç noktanın yolu. Yol "/" ile başlamalıdır.
Dil (Language)	İlk uç noktanın script dili: JavaScript veya Groovy.

Başlangıç script'i kısa bir JSON iletisi döndürür. Script'i değiştirmek için düzenleyicide Yapılandır düğmesine tıklayın.

Script-2-API Düzenleyicisi

Script API Oluştur penceresinde Yeni düğmesine tıkladığınızda düzenleyici açılır. Düzenleyiciyi listedeki Düzenleyiciyi aç seçeneğiyle de açabilirsiniz. Düzenleyicide bir sol sütun, bir orta bölüm ve üstte bir düğme çubuğu bulunur.

bilgi

Veri değiştiren her panel ve pencere kendi Kaydet düğmesini taşır. Kaydet değişikliği hemen saklar.

Sol Sütun

• Script-2-API'nin adı ve açıklaması üstte yer alır. Özet satırı uç nokta ve API Proxy sayısını gösterir.
• Kalem düğmesi Ad ve açıklamayı düzenle penceresini açar. Adı ve açıklamayı değiştirin. Sonra Kaydet düğmesine tıklayın. Apinizer değişikliği hemen saklar.
• API Uç Noktaları uç noktaları listeler. + düğmesi yeni uç nokta ekler.
• Her uç nokta kartında metot, yol, dil rozeti (GROOVY veya JS) ve açıklama görünür.
• Uç noktanın tam yolunu ve açıklamasını görmek için imleci kartın üzerinde tutun.
• Uç noktayı seçmek için karta tıklayın. Seçili kart vurgulanır.

Orta Bölüm

Orta bölümün üstünde seçili uç noktanın metodu, yolu, dili ve açıklaması görünür. Sağda uç noktanın işlemleri bu sırayla yer alır:

Düğme	Ne yapar
Dene (Try it)	Bu uç nokta için Dene panelini açar. Ayrıntılar için Script-2-API'yi Deneme bölümüne bakın. Script-2-API'nin API Proxy'si yoksa düğme devre dışıdır. Nedenini görmek için imleci düğmenin üzerinde tutun.
Yapılandır (Configure)	Uç noktanın Yapılandırma panelini açar. Ayrıntılar için Uç Nokta Oluşturma bölümüne bakın.

Yapılandır düğmesini ve Salt okunur · düzenlemek için Yapılandır'ı kullanın notunu yalnız API Creator'ı yönetebilen kullanıcılar görür.

Başlığın altında uç noktanın script'i yer alır. Kod görünümünde satır numaraları bulunur. Görünüm sayfayı doldurur. Script salt okunurdur. Script'i değiştirmek için Yapılandır düğmesine tıklayın.

Üstteki Düğmeler

Düzenleyicinin üstündeki düğme çubuğunda şu düğmeler bulunur. Düğmeler soldan sağa bu sırayla dizilir.

Düğme	Ne yapar
Geri (Back)	Script-2-API listesine döner.
Spec'leri göster (Show Specs, göz simgesi)	Script-2-API'nin OpenAPI tanımını bir pencerede gösterir. Pencerede Open API Yaml ve Open API JSON sekmeleri bulunur. Tanımı kopyalayabilir veya indirebilirsiniz.
Proxyleri Yönet (Manage API Proxies)	Script-2-API'den oluşturulan API Proxy'leri ve yükleme durumlarını gösterir. Ayrıntılar için Yükle (Deploy)/Yeniden Yükle (Redeploy) bölümüne bakın.
API Proxy Oluştur (Create API Proxy)	API Proxy Oluştur penceresini açar. Ayrıntılar için Script-2-API'den API Proxy Oluşturma bölümüne bakın.
Diğer işlemler (More actions, ⋯)	Bir menü açar. Aktarım > Dışa Aktar Dışa/İçe Aktarma Sihirbazı'nı bu Script-2-API için açar. Geçmiş > Denetim ve Geri Yükleme başlıklı yan paneli açar; ayrıntılar için Varlık Yaşam Döngüsü sayfasına bakın. Menünün sonunda kırmızı renkli Sil ve Script-2-API adı Script-2-API'yi siler.

Uç Nokta Oluşturma

Uç nokta eklemek için API Uç Noktaları başlığının yanındaki + düğmesine tıklayın. Seçili uç noktayı değiştirmek için Yapılandır düğmesine tıklayın. Sağdan Yapılandırma paneli açılır. Panel tanımı ve script'i birlikte düzenler.

Yeni bir uç noktada panelin başlığı Yeni uç nokta olur. Yeni uç nokta bir başlangıç script'iyle gelir. Var olan bir uç noktada başlık metodu ve yolu gösterir.

Uç nokta alanları aşağıda gruplar halinde yer alır:

Temel Bilgiler

HTTP Metot

Alan: HTTP Metot (HTTP Method)

Zorunlu. Uç noktanın HTTP metodunu seçin: GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH, TRACE veya QUERY.

Yol

Alan: Yol (Path)

Zorunlu. Uç noktanın erişim adresi. Yol "/" ile başlamalıdır. Başlamazsa hata iletisi görünür. API Proxy oluşturduğunuzda istemci uç noktaya bu adresle erişir.

Açıklama

Alan: Açıklama (Description)

Uç noktanın açıklaması.

Script Ayarları

Dil

Alan: Dil (Language)

Zorunlu. Script'in dilini seçin: JavaScript veya Groovy. Kaydedilmiş bir uç noktada script değişirse alanın yanında Kaydedilmemiş script değişikliği rozeti görünür.

Script

Alan: Script

Uç noktanın kod düzenleyicisi. Düzenleyicide kod tamamlama, editör kontrolleri ve derleme kontrolü bulunur. Ayrıntılar için Script Düzenleyicisi bölümüne bakın. Uç noktayı kaydetmek için Ctrl+S (macOS'ta Cmd+S) tuşlarına basın.

Değişkenler ve Kod Parçaları

Alan: Düzenleyicinin üstündeki Kod parçaları satırı ve Değişkenler bandı

Bir kod parçasını veya değişken çipini imlecin bulunduğu yere eklemek için ona tıklayın. Ayrıntılar aşağıdaki tabloda yer alır.

Dene

Düğme: Dene (Try it; script düzenleyicisinin araç çubuğu)

Script'i örnek veriyle çalıştırmak için Script'i Test Etme penceresini açar. Script boşsa düğme devre dışıdır. Ayrıntılar için Script'i Test Etme bölümüne bakın.

Kod parçaları satırı düzenleyicinin üstündedir. Hazır kodu imlecin bulunduğu yere eklemek için bir kod parçasına tıklayın. Eklenen kod seçili dile uyar. Kod parçaları şunlardır: Başlık oku, Sorgu parametresi oku, JSON döndür ve Hata döndür.

Değişkenler bandı, Kod parçaları satırı ile araç çubuğu arasında yer alır. Script-2-API backend'i çağırmadığı için bantta iki şerit bulunur. Bir çipe tıklayın. Apinizer değişkenin adını imlecin bulunduğu yere ekler. Bant şu bölümlerden oluşur:

Bölüm	İçerik
İstemci → Gateway (okunur)	requestHeaderMapFromClient, requestBodyTextFromClient, requestUrlParamMapFromClient, requestFormUrlEncodedListFromClient, requestFormDataListFromClient
Gateway → İstemci (yanıtta yazılır)	responseHeaderMapToClient, responseBodyTextToClient, statusCodeToClient, responseErrorMessageToClient
Ortak (Shared)	customVariableMap, environmentVariableMap, credentialMap, cache, stopFlowAsSuccess
Bağlam (Context)	Arama kutulu bir liste. Değerler şu gruplarda yer alır: Request, Response, Metadata, Date/Time, Error ve Credential. Eklemek istediğiniz bağlam değerini seçin. Apinizer değeri imlecin bulunduğu yere ekler.

Her çipin bir de ▾ bölümü vardır. ▾ bölümüne tıklayın. Açılan menü, değişkenin tipine uygun hazır kodu ve Adını kopyala seçeneğini sunar. Map tipindeki bir değişken için kod işlemleri şunlardır: Değer oku, Anahtar var mı kontrol et ve Tümünü dolaş. Yazılabilir bir Map ayrıca Değer yaz ve Anahtarı sil işlemlerini sunar. Gövde değişkenleri ayrıca JSON olarak oku işlemini sunar.

Mavi çip kenarlığı, değişkenin yazılabilir olduğunu gösterir. Kesikli kenarlık, değişkenin ekranda yeni olduğunu gösterir. Tümünde ara düğmesine tıklayın. Yan panelin Değişkenler sekmesi açılır. Gizle düğmesi bandı daraltır. Göster düğmesi bandı yeniden açar.

Panelin altında şu düğmeler bulunur:

• Uç noktayı sil onay aldıktan sonra uç noktayı siler. Bu düğme yeni bir uç noktada görünmez.
• İptal paneli kapatır ve değişikliklerinizi atar. Uç nokta yeniyse Apinizer uç noktayı oluşturmaz.
• Kaydet tanımı ve script'i birlikte saklar.

Kaydet düğmesi ve Ctrl+S (macOS'ta Cmd+S) önce script'i kontrol eder. Script hata içeriyorsa Script hata içeriyor penceresi sorar: Script'te N hata var. Script çalışma anında hata verebilir. Yine de kaydedilsin mi? Uç noktayı hatalarla kaydetmek için Yine de kaydet düğmesine tıklayın. Hataları düzeltmek için Geri dön düğmesine tıklayın. Kontrol, kaydetme işlemini hiçbir zaman engellemez.

Script Düzenleyicisi

Yapılandırma panelindeki script düzenleyicisi, Script politikasının düzenleyicisidir. Kodun üstünde Değişkenler bandı, bir araç çubuğu ve durum metni bulunur. Kodun altında bir sorun listesi yer alır. Yan panel kodun yanında açılır. Araç çubuğu ve sorun listesi şu öğeleri içerir:

• Motor etiketi, seçili dilin çalışma motorunu gösterir: Groovy 3.0.25 veya JavaScript (GraalJS).
• Öner, kod tamamlamayı açar. Kısayollar: Ctrl+Space, Alt+Space ve Ctrl+.
• Kontrol et, script'i Worker'da çalışma motoruyla derler. Kontrol et hiçbir şeyi çalıştırmaz. Projenin yayınlanmış bir ortamını gerektirir. Projede yayınlanmış ortam yoksa yalnızca editör kontrolleri çalışır.
• Kontrol et düğmesinin yanındaki durum metni sonucu gösterir. Örnekler: Hatasız derlendi (N ms). veya Derleme hatası var.
• Dene, Script'i Test Etme penceresini açar. Script boşsa düğme devre dışıdır. Ayrıntılar için Script'i Test Etme bölümüne bakın.
• Katalog ve sınıflar, yan paneli açar. Paneli gizle, paneli kapatır. Yan panel kapalı başlar. Böylece düzenleyici genişliğini korur.
• Sorun listesi Sorun yok yazar. Aksi halde hata ve uyarı sayısını gösterir. Her satır konumu gösterir. Örnek: Satır 3:5. İmleci o satıra götürmek için bir satıra tıklayın.

Düzenleyici, siz yazarken uyarı verir. Örneğin salt-okunur bir değişkene değer atamasını, println veya console.log çağrısını ve Groovy'de "${ad}" ifadesini işaretler. Script bu ifadeyle ortam değişkenini çözmez. environmentVariableMap.get("ad") kullanın.

Java sınıfları yalnızca Groovy script'lerinde kullanılabilir. Worker'daki JavaScript script'leri Java sınıfı yükleyemez; Java.type kullanılamaz.

Yan panelde üç sekme bulunur:

• Değişkenler: Değişkeni adıyla arayın. Adı kopyalamak için bir satıra tıklayın. Adı veya hazır kodu eklemek için ⋮ menüsünü kullanın.
• Katalog: Hazır kodları listeler. Kodu eklemek için İmlece ekle düğmesine tıklayın. Kodu kopyalamak için Kopyala düğmesine tıklayın. Script-2-API'de Katalog yalnız dört öğe gösterir: İstek başlığını oku, Sorgu parametresini oku, JSON yanıt döndür ve Hata yanıtı döndür. Script politikasının proxy akışı öğeleri burada görünmez. Bu öğeler backend değişkenlerini kullanır. Script-2-API backend'i çağırmaz.
• Sınıflar: Sınıfı adıyla arayın. Bir sınıf eklediğinizde import satırı da eklenir. Bu sekme yalnız Groovy için kullanılabilir.

Değişkenler bandı, araç çubuğu ve kontroller Script politikasındaki gibi çalışır. Bir fark vardır. Bu ekranda bir çipe tıklamak veya Bağlam kutusundan değer seçmek, adı veya değeri imlecin bulunduğu yere ekler. Script politikasında bu işlemler kopyalar. Kod tamamlama öğelerinin, editör kontrollerinin ve derleme kontrolü mesajlarının tam listesi için Script politikası sayfasındaki Script Gövdesi ve Değişken Yönetimi bölümüne bakın.

Değişkenler (Variables)

Script, mesajın başlık, parametre ve gövde bölümlerine anahtar kelimelerle erişir. Okuma ve yazma işlemleri bu anahtar kelimelerle yapılır. Yapılandırma panelinde düzenleyicinin üstündeki Değişkenler bandında bir çipe tıklayın. Apinizer değişken adını imlecin bulunduğu yere ekler. Bağlam değeri eklemek için bandın Bağlam kutusundan bir değer seçin.

Client → Apinizer (İstek Verileri)

İstemciden Apinizer'a gelen verilere erişim için kullanılan değişkenler:

Başlık (Header)

Değişken: requestHeaderMapFromClient

Veri Tipi: Map<String, String>

İşlem: Okuma

İstek başlıklarını okumak için kullanılır.

Parametre (URL Parameter)

Değişken: requestUrlParamMapFromClient

Veri Tipi: Map<String, String>

İşlem: Okuma

URL parametrelerini okumak için kullanılır.

Gövde (Body)

Değişken: requestBodyTextFromClient

Veri Tipi: String

İşlem: Okuma

İstek gövdesini okumak için kullanılır.

Mesaj Bilgisi (Context)

Değişken: contextValues

Veri Tipi: String

İşlem: Okuma

Mesaj bilgilerine erişim için kullanılır.

Özel Değişken

Değişken: customVariableMap

Veri Tipi: Map<String, String>

İşlem: Okuma, Yazma

Özel değişkenleri okumak ve yazmak için kullanılır.

Apinizer → Client (Yanıt Verileri)

Apinizer'dan istemciye gönderilecek verileri oluşturmak için kullanılan değişkenler:

Başlık (Header)

Değişken: responseHeaderMapToClient

Veri Tipi: Map<String, String>

İşlem: Yazma

Yanıt başlıklarını oluşturmak için kullanılır.

Gövde (Body)

Değişken: responseBodyTextToClient

Veri Tipi: String

İşlem: Yazma

Yanıt gövdesini oluşturmak için kullanılır.

Durum Kodu (Status Code)

Değişken: statusCodeToClient

Veri Tipi: Integer

İşlem: Yazma

HTTP durum kodunu ayarlamak için kullanılır.

Hata Mesajı (Error Message)

Değişken: responseErrorMessageToClient

Veri Tipi: String

İşlem: Yazma

İstemciye hata mesajı döndürmek için kullanılır. Hata döndür kod parçası bu değişkeni durum koduyla birlikte ayarlar.

Mesaj Bilgisi (Context)

Değişken: contextValues

Veri Tipi: String

İşlem: Okuma

Mesaj bilgilerine erişim için kullanılır.

Özel Değişken

Değişken: customVariableMap

Veri Tipi: Map<String, String>

İşlem: Okuma, Yazma

Özel değişkenleri okumak ve yazmak için kullanılır.

Form listeleri (requestFormUrlEncodedListFromClient ve requestFormDataListFromClient) ve ortak değişkenler (environmentVariableMap, credentialMap, cache ve stopFlowAsSuccess) Script politikasındaki gibi çalışır. Ayrıntılar için Flow Variables, Ortam Değişkenlerine Erişim, Credential Bilgilerine Erişim ve Cache Erişimi bölümlerine bakın.

bilgi

Script tipi Groovy ise:

• Mesaj gövdesi JSON olan durumda JsonSlurper
• Mesaj gövdesi XML olan durumda XMLSlurper

kullanılması mesaj işleme işlemini oldukça kolaylaştırır.

Script'i Test Etme

Script'i Test Etme penceresi, Yapılandırma panelindeki script'i örnek veriyle çalıştırır. Script'i kaydetmediyseniz de çalıştırır. Pencere API Proxy gerektirmez. Apinizer hiçbir şeyi kaydetmez ve backend'i çağırmaz.

Pencereyi Açın

Bir uç noktada Yapılandır düğmesine tıklayın veya yeni uç nokta için + düğmesine tıklayın. Script düzenleyicisinin araç çubuğundaki Dene düğmesine tıklayın. Bu düğme, uç noktanın başlığındaki Dene düğmesi değildir. Script'i Test Etme penceresi açılır. Başlığın yanındaki rozet script'in dilini gösterir.

Hattı Kontrol Edin

Script'iniz nerede çalışıyor? başlığının altında İstek veya Yanıt seçilidir. Pencere, script'inizdeki değişkenlerin çalıştığı hattı seçer. İstemciye yanıt yazan bir script Yanıt hattında çalışır. Hattı değiştirebilirsiniz.

Ortamı Seçin

Ortam listesinden bir ortam seçin. Ortam seçmeden script'i çalıştıramazsınız.

Test Verisini Girin

1 Test verisi bölümünde örnek veriyi girin. Yalnız script'inizin okuduğu değerleri doldurun. Diğer değerler boş kalabilir.

Test Bağlamını Ayarlayın (İsteğe Bağlı)

Script'iniz istemciyi veya HTTP metodunu okuyorsa kartların altındaki Test bağlamı kutusunu kullanın. Credential (doğrulanan istemci) listesinden bir tüketici seçin. Pencere credential_* değerlerini ve credentialMap değişkenini doğrulanmış bir çağrıdaki gibi doldurur. Varsayılan değer Credential yok seçeneğidir. HTTP metodu listesinden bir metot seçin. Pencere request_httpMethod değerini doldurur. Varsayılan değer POST'tur.

Script'i Çalıştırın

Script'i Çalıştır düğmesine tıklayın veya Ctrl+Enter tuşlarına basın (macOS'ta Cmd+Enter). Ortam seçmeden ve script yazmadan düğme devre dışı kalır. Sonuç 3 Sonuç bölümünde görünür.

Pencere çalıştırmadan önce editör kontrollerini ve derleme kontrolünü çalıştırır. Script hata içeriyorsa Script hata içeriyor penceresi sorar: Script'te N hata var. Yine de çalıştırılsın mı? Script'i çalıştırmak için Yine de çalıştır düğmesine tıklayın. Hataları düzeltmek için Geri dön düğmesine tıklayın.

Pencerede üç sütun bulunur:

Sütun	Açıklama
1 Test verisi	Bir bilgi mesajı, script'inizin okuduğu ve hâlâ boş olan verileri listeler. Bu verileri eklemek için mesajdaki bir düğmeye tıklayın. Mesajın altında kartlarda örnek mesajlar yer alır: From Client, To Backend, From Backend ve To Client. Pencere, script'inizin kullandığı mesajları ve alanları gösterir. Alanlar şunlardır: Başlıklar, Parametreler, Request URL Path, Gövde, Hata Mesajı ve Durum Kodu. script okur ve script değiştirir rozetleri script'inizin kullandığı alanları işaretler. Karta başka bir alan eklemek için Alan ekle: satırındaki alana tıklayın. Doldurmadığınız bir alanı gizlemek için Gizle düğmesine tıklayın. Test bağlamı kutusu sütunun sonundadır.
2 Script	Kod tamamlama, editör kontrolleri, derleme kontrolü (Kontrol et) ve sorun listesi olan bir kod düzenleyicisinde script. Ayrıntılar için Script Düzenleyicisi bölümüne bakın. Script'i değiştirip yeniden çalıştırın. Pencereyi kapattığınızda değişiklikleriniz Yapılandırma paneline aktarılır. Script boşsa pencere Script boş. Test etmek için bir script yazın. uyarısını gösterir. Düzenleyicinin altında Değişkenler paneli bulunur. Bir değişkenin adını kopyalamak için değişkene tıklayın. Script'inizde geçen değişkenler vurgulanır. Her değişken grubunun rozeti seçili hattaki erişimi gösterir: Yalnızca okunur, Okunur ve değiştirilir veya Burada kullanılamaz.
3 Sonuç	Son çalıştırmanın sonucu. Ayrıntılar aşağıdaki tabloda yer alır.

Sonuçta şu bölümler bulunur:

Bölüm	Açıklama
Sonuç durumu	Başarılı veya Başarısız, milisaniye cinsinden çalışma süresi ve değişiklik sayısı. Değişiklik yok yazıyorsa script hiçbir şeyi değiştirmemiştir. İlk çalıştırmadan önce sütun Henüz sonuç yok mesajını ve bir ipucu gösterir.
Değişiklikler	Başlık Backend API'ye giden istek veya Client'a giden yanıt olur. Tablolar sonucu To Backend veya To Client test verisiyle karşılaştırır. Her satırda bir rozet bulunur: eklendi, değişti, silindi veya değişmedi. Değişmeyen satırları görmek için Değişmeyen N satırı göster düğmesine tıklayın.
Gövde	Script gövdeyi değiştirdiyse yeni gövde değişti rozetiyle görünür. Eski gövdeyi görmek için Script öncesi gövdeyi göster düğmesine tıklayın.
Backend URL ve durum kodu	Değer varsa sonuç Özelleştirilmiş Backend URL ve Durum Kodu satırlarını gösterir.
Hata	Script hata verirse sonuçta Script bir hatayla durdu. iletisi, bir ipucu ve neden görünür. Hata boş test verisinden kaynaklanabiliyorsa sonuç boş değerlerin adlarını listeler.
Akışın kesilmesi	Script bir hata mesajı ayarlarsa sonuçta Akış burada durur. Client bu hatayı alır. iletisi ve durum kodu görünür. stopFlowAsSuccess true ise sonuçta Akış burada SUCCESS sonucuyla durur. Client bu mesajı alır. iletisi görünür.
Script'e verilen değerler (N)	Sonucun altındaki kapalı bir panel. Panel, script'in aldığı değerlerin adlarını listeler. Adları kaynağa göre gruplar: Test girdilerinden, Ortamdan, Seçilen credential'dan, Try It'te sabit ve Çalışma zamanı servisi. Panel yalnız adları gösterir. Değerleri hiçbir zaman göstermez.

Çalıştırmadan sonra veriyi, test bağlamını veya script'i değiştirirseniz bir not script'i yeniden çalıştırmanızı söyler.

bilgi

Script'i Test Etme penceresi script'i gateway ile aynı motorlarda çalıştırır: Groovy ve JavaScript (GraalJS). JavaScript script'leri Java sınıfı yükleyemez; Java.type kullanılamaz. Java sınıfları yalnızca Groovy script'lerinde kullanılabilir.

not

Script'i Test Etme penceresi gizli değerleri ****** olarak maskeler. Bu, tüketicinin parolası, tüketicinin diğer gizli alanları ve gizli ortam değişkenleri için geçerlidir. Script'i Test Etme yalnızca test projesinin ve yönetici projesinin anahtar nesnelerini (sertifika, anahtar, keystore ve JWK) alır. Sertifikalar ve açık anahtarlar gerçek değerleriyle gelir. Özel anahtarlar, gizli anahtarlar, keystore'lar ve JWK'ler yalnızca adıyla bulunur; değerleri null olur. Yalnız projenin tüketicileri kullanılabilir. Derleme kontrolü ve Dene, API Creator veya Genel Ayarlar için MANAGE yetkisi olan kullanıcılara açıktır. Cache yazmaları gerçek cache'e değil, geçici bir test cache'ine gider.

Script-2-API'yi Deneme

Uç noktanın başlığındaki Dene düğmesi Dene panelini açar. Bu panel Script'i Test Etme penceresinden farklıdır. Yapılandırma panelindeki script düzenleyicisinin araç çubuğunda da bir Dene düğmesi bulunur. Bu düğme Script'i Test Etme penceresini açar.

• Script'i Test Etme penceresi, Yapılandırma panelindeki script'i çalıştırır. Script'in kaydedilmiş olması gerekmez. Pencere API Proxy gerektirmez.
• Dene paneli, kaydedilmiş script'e bir API Proxy üzerinden gerçek bir istek gönderir.

not

Dene paneli isteği Test Konsolu'nun istek gönderme hizmetiyle gönderir. Bu nedenle Test kategorisinde Çalıştır yetkisine sahip olmanız gerekir. Yetkiler için Yetkilendirme Matrisi sayfasına bakın.

bilgi

Dene paneli Script-2-API'ye yönlenen bir API Proxy gerektirir. Script-2-API'nin API Proxy'si yoksa Dene düğmesi devre dışıdır. Önce bir API Proxy oluşturun. Ayrıntılar için Script-2-API'den API Proxy Oluşturma bölümüne bakın.

Dene paneli Mock API'deki panelle aynıdır. Panelin tüm bölümleri için Mock API'yi Deneme bölümüne bakın.

Paneli Açın

Düzenleyicinin sol sütununda bir uç nokta seçin. Uç noktanın başlığındaki Dene düğmesine tıklayın. Sağdan Dene paneli açılır.

API Proxy ve Ortamı Seçin

API Proxy ve Ortam listeleri aynı satırdadır. Panel ilk API Proxy'yi ve bu API Proxy'nin ilk ortamını seçer. Başka bir API Proxy kullanmak için API Proxy listesinden seçim yapın. Sonra Ortam listesinden ortamı seçin. Ortam listesi yalnız API Proxy'nin yüklü olduğu ortamları gösterir.

İsteği Hazırlayın

İstek bölümü metodu ve tam istek adresini gösterir. İsteği Parametreler, Başlıklar ve Gövde sekmelerinde değiştirin.

• Her yol parametresi için bir değer girin. Yoldaki her parametre için bir alan görünür.
• Sorgu parametresi eklemek için Parametreler sekmesinde + Ekle düğmesine tıklayın.
• Başlık eklemek için Başlıklar sekmesinde + Başlık düğmesine tıklayın. Sekme Accept: application/json başlığıyla başlar.
• İstek gövdesini Gövde sekmesine yazın. Bu sekme gövde taşıyan metotlarda görünür. Örneğin POST, PUT ve PATCH. Bu metotlarda panel Content-Type: application/json başlığını da ekler.

İsteği Gönderin

Adres satırının sonundaki Gönder düğmesine tıklayın. Yanıt bölümü durum kodunu, yanıt süresini, boyutu, yanıt gövdesini ve yanıt başlıklarını gösterir.

İstek kartında cURL kopyala ve Sıfırla düğmeleri de bulunur. Yüklenmemiş bir API Proxy Yüklenmedi rozetiyle görünür. Panel Script-2-API için hiç API Proxy bulamazsa Bu API için henüz API Proxy yok başlığını ve API Proxy Oluştur düğmesini gösterir.

Script-2-API'den API Proxy Oluşturma

bilgi

Script-2-API'den API Proxy oluşturmak için en az bir uç nokta olmalıdır. Uç nokta yoksa API Proxy Oluştur düğmesi devre dışıdır.

Script-2-API'yi API Proxy olarak erişime açmak için düzenleyicinin üstündeki API Proxy Oluştur düğmesine tıklayın.

API Proxy Oluştur penceresi açılır.

Pencere Script-2-API'nin adından bir ad ve göreli yol önerir. Gerekirse bunları değiştirin. Pencerede şu alanlar bulunur:

Alan	Açıklama
Proxy adı (Proxy name)	Zorunlu. Apinizer adın benzersiz olup olmadığını denetler.
Göreli Yollar (Relative Paths)	İstemcinin API Proxy'ye eriştiği yollar. Projede göreli yol öneki varsa önek yolların başında görünür. Her yol "/" ile başlamalıdır. Yol eklemek için + Yol ekle düğmesine tıklayın.
Metotlar (Methods)	Listeden bir veya birkaç metot seçin: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS veya QUERY. Hiçbirini seçmezseniz Apinizer tüm metotları yönlendirir.
Host'lar (Hosts)	+ Host ekle düğmesiyle host ekleyin.
Başlıklar (Headers)	+ Başlık ekle düğmesiyle istek başlığı ekleyin. Her başlık için ad ve değer girin.
Kategori Listesi (Category List)	Kategori adını yazın ve Enter tuşuna basın.
Yüklenecek ortamlar (Deploy to)	API Proxy'nin yükleneceği ortamları işaretleyin. Her ortamın erişim adresi yanında görünür.
Gateway URL	API Proxy'nin gateway adresinin önizlemesi.

Göreli Yollar, Metotlar, Host'lar ve Başlıklar alanları İstemci Rotası (Client Route) bölümünü oluşturur. En az bir yol, metot, host veya başlık tanımlayın. Ayrıntılar için Client Route Ayarları sayfasına bakın.

İlk ortam varsayılan olarak işaretli gelir. API Proxy'yi şimdi yüklemek istemiyorsanız işareti kaldırın.

Oluştur ve yükle (Create and deploy) düğmesine tıklayın. Apinizer API Proxy'yi oluşturur ve işaretli ortamlara yükler. Hiçbir ortam işaretlemezseniz Apinizer yalnız API Proxy'yi oluşturur. API Proxy oluşturmadan pencereyi kapatmak için İptal düğmesine tıklayın.

Bu adımdan sonra yapılabilecekler API Proxy dokümanı ile aynıdır. Ayrıntılar için API Proxy Oluşturma sayfasına bakın.

not

Bir Script-2-API için birden fazla API Proxy oluşturabilirsiniz.

Yükle (Deploy)/Yeniden Yükle (Redeploy)

API Proxy'yi oluştururken ortamları işaretlediyseniz Apinizer API Proxy'yi bu ortamlara zaten yükler. Yüklemeyi sonradan API Proxy'ler sayfasından veya düzenleyicideki Proxyleri Yönet düğmesiyle yönetebilirsiniz.

Proxyleri Yönet düğmesi bir pencere açar. Pencere Script-2-API'den oluşturulan API Proxy'leri listeler. Pencerede API Proxy'leri yükleyebilir, yeniden yükleyebilir ve yüklemelerini kaldırabilirsiniz. Ayrıntılar için Yükleme, Yeniden Yükleme, Kaldırma, Deployment Geçmişi ve Rollback sayfasına bakın.

Yükleme onay penceresi açılır. İsterseniz Açıklama alanını doldurun. Sonra Yükle (Deploy) düğmesine tıklayın.

bilgi

Script-2-API'ye uç nokta eklediğinizde veya bir uç noktadaki değişikliği kaydettiğinizde bu API'den oluşturulan tüm API Proxy'leri yeniden yükleyin. Yeniden yüklemezseniz değişiklik geçerli olmaz.

Değişikliği kaydettiğinizde Proxyleri Yönet düğmesinin yanında Yeniden yüklenmeli uyarısı görünür.

Değişiklikleri API Proxy'lere uygulamak için Proxyleri Yönet penceresinde API Proxy'nin satırındaki yeniden yükleme düğmesine tıklayın.

Yeniden yükleme onay penceresi açılır. İsterseniz Açıklama alanını doldurun. Sonra Yeniden Yükle (Redeploy) düğmesine tıklayın.

API Proxy sayfasına gitmek için Proxyleri Yönet penceresinde API Proxy'nin adına tıklayın.

Benzer şekilde, API Proxy sayfasından Script-2-API'ye gitmek için API Proxy'deki Script-2-API'nin adına tıklayın.

Script-2-API Silme

Script-2-API'yi silmek için listede satırın ⋮ menüsünden Sil seçeneğine tıklayın. Silme penceresi Script-2-API ile birlikte silinecek API Proxy'leri listeler. Onaylamak için Script-2-API'nin adını yazın. Sonra Sil düğmesine tıklayın.

Apinizer önce Script-2-API'ye bağlı tüm API Proxy'lerin yüklemesini kaldırır (undeploy). Sonra API Proxy'leri siler.