Parametreler, API'lerle veya web hizmetleriyle uğraşırken sıkça karşılaşılan bir durumdur. Belki de parametreleri uzun zamandır kullandığınızın farkında değilsinizdir! Parametrelerle etkileşimde bulunduğunuz yaygın bir yer, web sitesi URL'leridir. Ancak, farklı türde parametreler olduğunun farkında mısınız?
Parametrelerle ilgileniyorsanız, Apidog iyi bir başlangıç seçeneği olabilir. Basit ve sezgisel bir kullanıcı arayüzü ile, aşağıdaki düğmeye tıklayarak hızlıca başlayın! 👇 👇 👇
Bu makale, parametrelerin temellerini tanıtacak, ardından yol ve sorgu parametrelerinin neler olduğunu inceleyecektir. Ayrıca, hangi senaryoların yol parametresini sorgu parametresine tercih ettiğine ve tam tersine dair bir bölüm de olacaktır.
Önce Temeller: API'lerde Parametreler
API'lerde parametreler, bir API isteğinin işlevselliğini doğrudan etkileyebilen değişken öğelerdir. Parametreler, API'lere belirli ayrıntılar veya talimatlar sağlar ve API'yi yanıtına neleri dahil edeceğinden sorumlu kılar.
Parametre İşlevleri
İşleri kolaylaştırmak için, parametrelerin API geliştiricilerine sağlayabileceği üç işlev noktası şunlardır:
- İstekleri belirtin: Parametreler, API'nin belirli bir kaynak üzerinde gerçekleştirmesini istediğiniz eylemin türünü tanımlayabilir.
- Yanıtları özelleştirin: Parametreler, isteğinize yanıt olarak API tarafından sunulan içeriği veya biçimi etkiler.
- Verileri filtreleyin: Parametreler, API'den alınan sonuçları filtrelemek için kullanılır.
Parametreleri Uygulamanın Çeşitli Yöntemleri
API isteklerinde parametreleri geçmenin birkaç yolu vardır. Bunun, yol ve sorgu parametreleri terimlerinin ortaya çıktığı yer olduğunu unutmayın.
- URL yolu: Bunlar,
/users/{id}gibi doğrudan URL yoluna dahil edilen değişkenlerdir; burada{id}, belirli bir kullanıcı kimliğini temsil eden bir parametredir.
Buradaki{id}parametresi, bir yol parametresi olarak adlandırılabilir. - Sorgu dizesi: Sorgu dizeleri, bir soru işaretinden (
?) sonra URL'ye eklenen anahtar-değer çiftleridir; örneğin,?limit=10&sort=name; buradalimitvesort, karşılık gelen değerlere sahip parametrelerdir.limitvesortgibi anahtar-değer çiftlerine ayrıca sorgu parametreleri denir. - Başlıklar: Bunlar, yetkilendirme belirteciniz veya tercih ettiğiniz dil gibi, istek ile birlikte gönderilen ek bilgilerdir.
- İstek gövdesi: Kaynak oluşturma veya değiştirme için karmaşık veriler, genellikle JSON veya XML gibi formatlarda istek gövdesinde gönderilebilir.
Yol Parametreleri Nelerdir?
Yol parametreleri, belirli değerler için bir yer tutucu görevi gören, bir API isteğinin URL yoluna doğrudan gömülü öğelerdir. API içindeki benzersiz kaynakları hedeflemek ve tanımlamak için kullanılırlar.
Yol Parametresi Örnekleri
/users/{id}, bir yol parametresine bir örnektir. Belirli bir kullanıcı için bir yol parametresini temsil eder (bir kullanıcı bu örnekte bir kaynaktır).
URL'de bu süslü parantezleri {} görürseniz, bu bir yol parametresidir. Ancak, pratikte, web sitelerinde süslü parantezleri görmezsiniz, çünkü bunlar API'nin çalışması için belirli değerlerle değiştirilir.
Neden Yol Parametreleri Kullanılır?
Yol parametreleri öncelikle, benzersiz tanımlayıcısına (ID) göre bir kullanıcı veya ürün gibi belirli bir veriyi veya varlığı belirlemek için seçilir.
Yol parametreleri ayrıca bir URL'nin okunabilirliğini artırmak için mükemmel bir yoldur. URL'lerin daha açıklayıcı ve kendi kendini belgeleyen olmasını sağlar, yani diğer geliştiriciler URL'yi anlarken aynı zamanda ne yapması gerektiğini de anlayabilirler.
Son olarak, yol parametreleri, bir API'nin kaynak modelinde hiyerarşik bir yapıyı temsil etmek için iç içe yerleştirilebilir, bu nedenle iç içe koleksiyonlar içindeki kaynaklara erişebilirsiniz. Bunu, tek bir dosyaya erişmek için klasörler içindeki klasörlere girmek gibi düşünebilirsiniz.
Sorgu Parametreleri Nelerdir?
Sorgu parametrelerinin başka adları vardır - URL parametreleri veya sorgu dizeleri. Bunlar, bir soru işaretinden ? sonra bir URL'ye eklenen ek bilgilerdir.
Sorgu parametreleri, bir ampersan & ile ayrılmış anahtar-değer çiftleri halinde gelir. Sorgu parametreleri, temel kaynağı değiştirmeden API istek davranışını değiştirmek için tasarlanmış isteğe bağlı talimatlar olarak adlandırılır.
Sorgu Parametresi Örnekleri
/users?sort=name&limit=10, iki sorgu parametresinden, sort ve limit'ten oluşan bir URL örneğidir.
Bu örnekteki anahtar-değer çiftleri sort=name ve limit=10'dur.
Neden Sorgu Parametreleri Kullanılır?
Yol parametrelerine kıyasla, sorgu parametreleri daha çok işlevsellikleri için kullanılır.
Sorgu parametreleri, aşağıdakiler gibi daha fazla bilgi ekleyerek bir API isteğinin davranışını değiştirebilir:
- Filtreleme: Belirli kriterlere göre sonuçları filtreleyin (örneğin,
?category=electronics). - Sıralama: Belirli kriterlere göre sonuçları sıralayın (örneğin,
?sort=price,desc). - Sayfalama: Daha iyi performans için sonuçları daha küçük parçalar halinde alın (örneğin,
?page=2&per_page=20). - Arama: Anahtar kelimelere göre belirli kaynakları arayın (örneğin,
?q=books).
Yol Parametreleri ve Sorgu Parametreleri - Tablolaştırılmış
| Özellik | Yol Parametresi | Sorgu Parametresi |
|---|---|---|
| Konum | URL yoluna gömülü ({id}) |
'?' işaretinden sonra eklenir (?sort=name&limit=10) |
| Amaç | Belirli kaynakları tanımlayın | İstek davranışını değiştirin (filtrele, sırala, vb.) |
| Zorunlu | Evet | Hayır |
| Güvenlik | Daha az güvenli (URL'de görünür) | Biraz daha güvenli (URL yolundan ayrılmış) |
| Okunabilirlik | Okunabilirliği artırır | Okunabilirliği azaltabilir |
| Hiyerarşi | İç içe yerleştirilebilir | Hiyerarşi için uygun değil |
2024'ün Eksiksiz ve Güçlü API Geliştirme Aracı - Apidog
Apidog, tüm bir API yaşam döngüsü için çeşitli spesifikasyonları ve değişiklikleri kolaylaştıran, hepsi bir arada bir API geliştirme platformudur. Kullanıcılar, Apidog yazılımı içinde API'leri oluşturabilir, test edebilir, hata ayıklayabilir, belgeleyebilir ve taklit edebilir.
Apidog, basit ama sezgisel bir kullanıcı arayüzünü sevenler için mükemmel bir platformdur. Yol ve sorgu parametrelerini tanımayı planlıyorsanız. Bu durumda, Apidog size REST API veya SOAP API'yi nasıl içe aktaracağınızı ve bunları nasıl değiştireceğinizi açıkça gösterebilir.
API Dosyalarınızı Apidog'a İçe Aktarma
Parametrelerin API'nin URL'lerine nasıl dahil edildiğini gözlemlemek için, bir API'yi Apidog'a içe aktarmanız gerekir.
API dosyanıza karşılık gelen uygun dosya türünü seçin. Tam dosya türünü bulamazsanız, yukarıdaki resimde gösterildiği gibi dosyayı pencerenin alt kısmına sürükleyin.
Apidog ile API Uç Noktalarını (veya API URL'lerini) Test Etme
Bir API'yi başarıyla içe aktardıktan sonra, Apidog ile bir istek göndererek bunları test etmek mümkündür.
Ok 1 ile gösterildiği gibi, ekranın sağ tarafında bulunan API'lerinizden birinin isteğini seçin.
Ardından, Ok 2 ile işaret edilen düğmeye tıklayarak isteği gönderebilirsiniz, ancak doğru ortamı seçtiğinizden veya doğru istek API URL'sini eklediğinizden emin olun.
Son olarak, isteği gönderdikten sonra alınan yanıtı görmek için yanıt bölümüne gidin ve beklenenle aynı olup olmadığını kontrol edin.
Apidog'da API URL'sine Parametre Ekleme
Resimde gösterildiği gibi Params başlığına tıklayarak API URL'sine kendi parametrelerinizi ekleyebilirsiniz. Bir parametre ekleyecekseniz, doğru yapıya (yol parametreleri için süslü parantezler {} ve sorgu parantezleri için belirli semboller &, ? ve = gibi) uymaya dikkat edin.
Sonuç
Parametreler, geliştiricilerin devasa bir koleksiyondan belirli kaynakları belirleyebildikleri için kullanmaları için son derece kullanışlı değişkenlerdir. Yol veya sorgu parametrelerini kullanarak, belirli kaynakları bir veritabanından elde etmek, güncellemek ve filtrelemek hiç bu kadar kolay olmamıştı. Oldukça benzer görünmelerine rağmen, bir yol parametresi, sorgu parametresine benzeyen bir yapıya sahip değildir. Bununla birlikte, her iki senaryoda kullanılan farklı sembolleri ve her iki parametrenin görüntülediği farklı biçimlendirmeyi anlamak çok önemlidir.
Apidog, çeşitli API dosya türlerini içe aktarabilen, hepsi bir arada bir API geliştirme platformudur. API geliştirmeyle ilgili birçok gerekli hizmeti sağlayan, olağanüstü bir API aracıdır. Kullanıcıların API'leri oluşturmasına, taklit etmesine, belgelemesine ve test etmesine olanak tanıyan işlevlerle, Postman ve SwaggerHub'ın yanı sıra kesinlikle sağlam bir API aracıdır.
