API parametrlərinin növləri

Application Programming Interface (API) proqramçıların proqram təminatı hazırlamaq və ya fərqli sistemlər arasında qarşılıqlı əlaqəni asanlaşdırmaq üçün istifadə etdikləri protokollar, rutinlər, funksiyalar və ya əmrlər toplusudur.API parametrlərini 4 əsas növə bölmək olar. Bunlar:

• Path Parameters
• Query Parameters
• Header Parameters
• Request Body Parameters

Path Parameters

Bu parametrlər API-nin URL-inə əlavə edilir. Bu parametrlər isteğe bağlı deyil, çünki onlar API son nöqtəsi URL-nin bir hissəsidir.

https://www.xyz.com/api/{user}/books/{bookID}/

Yuxarıdakı URL-də mötərizələrin içərisində müəyyən edilmiş user və bookID bizim path parametrlərimizdir. Bunlar serverə HTTP sorğusu göndərilərkən faktiki dəyərlərlə əvəz olunan "placeholders" kimi çıxış edir. Path parametrlərinə template parametr də deyilir.

Query Parameters

Query parametrləri çox yayılmışdır və sual işarəsindən sonra URL-in sonuna əlavə olunur. Bu parametrlər istəyə bağlıdır və parametrlərin əlavə olunma sırasının əhəmiyyəti yoxdur. Query sətirində & istifadə etməklə ayrılan çoxsaylı query parametrləri yazmaq olar.

https://www.xyz.com/search?userName=KananMirza&userID=27

Yuxarıdakı nümunə URL-də userName=KananMirza&userID=27 & istifadə edərək bir-birindən ayrılmış userName və userID-nin iki sorğu parametrindən ibarət query parameter-dir.Nə qədər ki, dəyişən adları düzgündür, onların əlavə edilmə sırasının əhəmiyyəti yoxdur. userName=KananMirza&userID=27 və userID=27&userName=KananMirza bizə eyni nəticə verəcəkdir.

Header Parameters

Bu parametrlər sorğunun header hissəsinə ötürülür. Onlar əsasən icazə (authorization) məqsədləri və ya API keys kimi həssas məlumatları ötürmək üçün istifadə olunur. Bəzi API-lər müştəriyə cavabı geri göndərmək üçün header parametr kimi unikal key tələb edirlər.

Request Body Parameters

POST, PUT və ya PATCH sorğuları ilə məşğul olarkən, əksər hallarda sorğunun əsas parametrləri JSON obyekti şəklində göndərilir. Key-value cütlərini ehtiva edən bu JSON obyekti body paramater kimi əlavə edilir, buna görə də bu parametrlər sorğunun əsas parametrləri adlanır. JSON obyektindəki key-value cütləri aşağıdakı kimi müəyyən edilə bilər:

{
"country": Azerbaijan,
"city": "Baku",
"postCode": Az1056
}

Kanan Mirzayev

Full Stack Web Developer

Bir proqramçını tanımağın ən yaxşı yolu onun yazdığı kodlara baxmaqdır.Github hesabıma keçid edə bilərsiniz.