Apidog'da API'ler tasarlarken, çok sayıda istek parametresi eklenmesini gerektiren durumlarla karşılaşabilirsiniz. Düzinelerce, hatta yüzlerce parametre gerektiren bir uç nokta düşünün. Her bir parametreyi "Düzenle" bölümünde tek tek eklemek zahmetli, zaman alıcı ve hatalara açık olabilir.
Neyse ki, Apidog, süreci daha sorunsuz ve daha verimli hale getiren toplu parametre ekleme yöntemleri sunar.
Bu makalede, istek parametrelerini toplu olarak eklemenin çeşitli yöntemlerini inceleyeceğiz. Detaylara dalalım.
Yöntem 1: Toplu Düzenleme Özelliğini Kullanma
Body parametre türü form-data veya x-www-form-urlencoded olduğunda, istek parametreleri eklemek için "Toplu Düzenleme" özelliğini kullanabilirsiniz.
Toplu Düzenleme İşlevine Erişim:
Parametre listesinde, sağ üst köşedeki "Toplu Düzenle" düğmesini bulun. Bu düğmeye tıklamak, parametreleri toplu olarak girebileceğiniz bir metin düzenleme kutusu açacaktır.
Parametreleri CSV Formatında Girin:
Parametreler CSV formatında olmalıdır. Örneğin, form-data parametreleri için gerekli format şöyledir:
Parameter Name, Type, Required, Example Value, Content-Type, Description
Virgülle ayrılmış her bir öğe, gerekirse boş bırakılabilir. Bu verileri düzenlemek ve hataları en aza indirmek için yapay zeka araçlarından yararlanabilirsiniz. İşte bir örnek:
email, string, false, user@gmail.com, text/plain, User's email address
password, string, false, ********, text/plain, User's password
Parametreleri girdikten sonra, ilgili istek parametrelerini oluşturmak için "Tamam" düğmesine tıklayın.
Yöntem 2: Mevcut Formatlardan Parametre Oluşturma
JSON veya XML gibi body parametre türleriyle çalışırken, parametreleri otomatik olarak oluşturmak için içeriği doğrudan belirli formata yapıştırabilirsiniz.
Parametreleri Toplu Olarak Eklemek İçin JSON Kullanın:
Parametre listesindeki "JSON'dan Oluştur" düğmesine tıklayın; bu, JSON nesnesini yapıştırabileceğiniz veya girebileceğiniz bir metin düzenleme kutusu açar.
JSON'daki yorumlar, parametre açıklamaları olarak tanınabilir. Gerekirse geçersiz kılma modunu veya adlandırma kurallarını belirtebilirsiniz. İşte bir örnek:
{"region_id": "82","email": "b.wawjn@gmail.com", // User's email"sales_channel_id": "12","customer_id": "98","country_code": "70", // Country code"context": {"ip": "::1","user_agent": "Chrome"
},// Other parameters...
}
Onaylamadan önce girilen JSON verilerini önizleyebilirsiniz.
Düzenledikten sonra, ilgili istek parametrelerini oluşturmak için "Tamam" düğmesine tıklayın.
"Otomatik Oluştur" anahtarı açıksa, istek örnekleri de oluşturulur.
Parametreleri Toplu Olarak Eklemek İçin XML Kullanın:
JSON'a benzer şekilde, XML verilerinizi de düzenleme kutusuna yapıştırabilirsiniz. İlgili istek parametrelerini oluşturmak için "Tamam" düğmesine tıklayın. İşte bir örnek:
Veritabanından İçe Aktar:
Ayrıca, bağlanarak ve istenen veri tablolarını seçerek parametreleri bir veritabanından içe aktarma seçeneğiniz de vardır. Veritabanındaki alan yorumları, açıklamalar veya adlar olarak kullanılabilir.
Alternatif olarak, parametreler oluşturmak için SQL DDL ifadeleri girebilirsiniz (şu anda yalnızca MySQL'i destekler), şöyle:
CREATE TABLE
carts
(
id int NOT NULL AUTO_INCREMENT,
region_id varchar(10) DEFAULT NULL,
email varchar(255) DEFAULT NULL,
sales_channel_id varchar(10) DEFAULT NULL,
customer_id varchar(10) DEFAULT NULL,
country_code varchar(10) DEFAULT NULL,PRIMARY KEY (
id
)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
Yöntem 3: Ortak Parametreler/Veri Modelleri Ekleme
Apidog, önceden tanımlanmış parametre şablonları oluşturmanıza ve kullanmanıza olanak tanır; bu, benzer API'lerde, özellikle ortak parametreler ve veri modelleri aracılığıyla yeniden kullanıma olanak tanır.
Ortak Parametreler Ekleme:
Sol gezinme çubuğunda, "Ayarlar"ı seçin, ardından sık kullandığınız parametreleri eklemek için "Ortak Parametreler"e tıklayın.
API'de ortak bir parametre kullanmanız gerektiğinde, sadece parametre giriş kutusuna tıklayın; önceden tanımlanmış parametrelerinizi hızlı bir şekilde seçmeniz için bir seçim paneli görünecektir.
Şemalar Ekleme:
Sol gezinme çubuğunda "Şemalar" seçeneğini bulun, "Yeni Şemalar" düğmesine tıklayın, modelin adını ve açıklamasını girin, ardından alanlar ekleyin ve her alanın türünü, örnek değerini ve açıklamasını tanımlayın.
Şemalar parametreleri, Yöntem 2'de belirtildiği gibi JSON veya JSON Şeması aracılığıyla da oluşturulabilir.
İstek veya yanıtta bir şema kullanmanız gerektiğinde, sadece türüne (örneğin, nesne) tıklayın ve açılır listeden "Diğer şemalara referans ver"i seçin.
Önceden tanımlanmış şemaları listeden seçin ve parametreler otomatik olarak API'ye doldurulur.
Bazı parametreler eklemeniz veya değiştirmeniz gerekirse, bunları ilgili "Veri Şeması"nda değiştirebilir veya referanslarını kaldırabilirsiniz. Referans kaldırıldığında, istek parametreleri artık ortak veri modeline bağlı değildir, ancak bağımsız olarak var olur ve yalnızca mevcut API'ye aittir.
Yöntem 4: cURL Komutlarını İçe Aktarma
Apidog, cURL komutlarının doğrudan içe aktarılmasını destekler ve özellikle Shopify API gibi test amaçlı cURL komutları sağlayan üçüncü taraf platformlardan API'ler için istek parametrelerinin hızlı bir şekilde kurulmasını sağlar.
Bir cURL komutunu içe aktarmak için, sağlanan komutu kopyalayıp yeni bir API'nin adres çubuğuna yapıştırın. Apidog, cURL komutunu otomatik olarak ayrıştıracak ve ilgili istek parametrelerini oluşturacaktır.
Ayrıca projenizdeki arama kutusunun yanındaki "+" düğmesine tıklayabilir, "cURL İçe Aktar"ı seçebilir, kopyaladığınız komutu iletişim kutusuna yapıştırabilir ve "Tamam"a tıklayabilirsiniz.
Bir API olarak kaydettikten sonra, JSON istek gövdesi, API dokümantasyonuyla eşleşecek şekilde otomatik olarak yapılandırılacaktır.
Sonuç
Bu makale, Apidog'da istek parametrelerini toplu olarak eklemek için çeşitli yöntemler sunmuştur. CSV verileri için toplu düzenleme işlevini kullanabilir, JSON veya XML formatlarından parametreler oluşturabilir, veritabanlarından içe aktarabilir, önceden tanımlanmış parametre şablonlarını kullanabilir veya doğrudan cURL komutlarını içe aktarabilirsiniz. Bu çeşitli yaklaşımlar, API istek parametrelerinizi ihtiyaçlarınıza göre verimli bir şekilde yönetmenizi sağlar.
