API olmadan API olmadan qoşulun: 8 addım

2024 Müəllif: John Day | [email protected]. Son dəyişdirildi: 2024-01-30 07:44

Bu təlimat, bir API istifadə etməyi tələb edən, ancaq necə başlayacağından tam əmin olmayan bir şeyə sahib insanlar üçün hazırlanmışdır. Bir API ilə işləməyin niyə faydalı olduğunu artıq bilirsiniz və bu təlimat bunu necə edəcəyinizi sizə göstərəcək.

Bu sizin kimi səslənirsə, şanslısınız! API ilə necə işləməyi, API sənədlərini necə oxumağı və bir API -dən geri gələn məlumatları necə istifadə etməyi izah etmək üçün buradayıq.

Gəzintini asanlaşdırmaq üçün bir dost gətirdik.

Slash ilə tanış olun

Slash, Michelle'in sevimli, sevimli itidir (yuxarıdakı şəkil). Michelle, API quran bir proqram mühəndisidir. Michelle, işindən çox zövq alır və Slash təlimində API quraraq işlərindən ilham alır.

Bildiyiniz kimi, API, istifadəçinin bir veb xidmətinə verə biləcəyi əmrlər toplusudur və sorğuya uyğun gələn cavablar dəstidir. Michelle, Slash -ı da eyni şeyi öyrətdi. Slash yaxşı bir uşaqdır, müxtəlif əmrləri bilir və ona öyrədilmiş bir istəyi verdiyiniz müddətdə həmişə düzgün cavab verir. Əlavə həyəcanlandığı zaman quyruğu dəli olur - bu, Michelle -in API -lərlə əlaqəli öyrətdiyi bir şey deyil, sadəcə sevimli bir bala olması və məşqindən çox zövq almasıdır!

Addım 1: Hansı API -yə ehtiyacınız olduğuna qərar verin

Hansı məlumatı axtarırsınız və ya dəyişdirmək istəyirsiniz?

@Dougthepug -un Instagram yazılarının hamısını tutmağa çalışırsınız? Bəlkə də köpeğinizin twitterini izləyən hər kəsə avtomatik olaraq tvit yazmaq istərdiniz (çünki itlər danışa bilməsə də, söyləyəcəkləri çox şey var, bilirik ki, Slash bunu bilir).

Qoşulmağa çalışdığınız saytı və ya API -ni artıq bilirsinizsə, birbaşa 2 -ci addıma keçin. Məlumat axtarmağa çalışırsınız, amma haradan başlayacağınızdan əmin deyilsinizsə, Google sizin dostunuzdur. "[Maraqlandığınız şeylər] API" ni axtarın və nələr gəldiyini görün. Orada nə qədər məlumat olduğuna təəccüblənə bilərsiniz.

Sadə bir API nümunəsi istəyirsinizsə, Michelle -dən Slash təlimi zamanı istifadə edə bilərsiniz. Topları almaq və çuxurlar qazmaq kimi ən çox sevdiyi əmrləri var. Qalan nümunələrimizdə istifadə edəcəyik.

Addım 2: API Sənədlərini tapın

Tanınmış şirkətlər tərəfindən təqdim olunan API-lərdə onlardan necə istifadə olunacağına dair hərtərəfli sənədlər olmalıdır.

Bunları tapmaq üçün google "[Insert Company] API Documents" və ya "[Insert Company] developer".

Nəticələr sizi geliştirici portalına aparmalıdır. "Sənədlər", "Sənədlər", "İstinad" və ya "Texniki İstinad" deyən bir bağlantı axtarın.

Sənədlərdə istədiyiniz xüsusi bir API axtarmağınız lazım ola bilər, çünki bəzən bir çox variant ola bilər. Facebook, məsələn, marketinq, reklamlar, səhifələr və daha çox üçün ayrı API -lərə malikdir.

Qoşulmaq istədiyiniz API yaxşı bilinməsə (Slash kimi), inkişaf etdiricidən sənəd istəməyiniz lazım ola bilər. Ehtiyacınız olan məlumatları və ya veb saytında olmayan onlayn sənədləri ehtiva edən bir PDF ola bilər.

Əvvəlki addımda keçidi qaçırdınızsa, Slash -in API sənədlərini burada tapa bilərsiniz.

Addım 3: Son nöqtəni tapın

API sənədləri çətin görünə bilər, amma nə axtarmalı olduğunuzu bildikdən sonra ümumiyyətlə yaxşı qurulmuş və olduqca standartlaşdırılmışdır.

Axtarılan ilk şey uyğun son nöqtədir. İstədiyiniz hər bir məlumat növünə uyğun bir son nöqtə olmalıdır. Bir son nöqtə belə görünə bilər:

slashtheapidog.com/api/bones/{id}

ya da sadəcə

/sümüklər

Sənəddə son nöqtələrin siyahısı olmalıdır. Sənədlərdə və ya "istinad", "son nöqtələr" və ya "metodlar" adlı bir bölmənin altında ən yüksək səviyyədə ola bilərlər. Doğru son nöqtəni tapmaq üçün aradığınız məlumatlara uyğun olan ad axtarın. Məsələn, Slash'ın qazdığı bütün deliklərin siyahısını istəyirsinizsə, /deşiklər yəqin ki, ən doğrusudur. Hər halda, hər bir son nöqtənin nə etdiyini izah etməyə kömək edəcək bir təsviri olmalıdır.

Sənədlərindən Slash API -də deliklər ilə əlaqəli son nöqtələr bunlardır:

Https://slashtheapidog.com/api/holes əldə edin

Https://slashtheapidog.com/api/holes/{id} əldə edin

YAYIN

Https://slashtheapidog.com/api/holes/{id} yazın

YAYIN

Addım 4: İstək növünüzü müəyyənləşdirin

Doğru son nöqtəni tapdığınız üçün onu göndərmək üçün sorğu növünü təyin etməlisiniz.

4 fərqli sorğu növü var:

ALIN

GET tələbi, API -dən ən çox məlumatı olan bir şeylə cavab verməsini istəməyinizdir. Bitiş nöqtəsinə və parametrlərə əsaslanaraq bir maddə və ya bir qrup maddə haqqında xüsusi məlumat istəyə bilərsiniz. Bu, Slash -dən sümüklərindən birini və ya bütün sümüklərini gətirməsini istəməyə bərabərdir.

POST

POST sorğusu, API -yə yeni bir şey yaratmağı söyləməyinizdir. Bu, Slash -in sizin üçün yeni bir çuxur qazmasını (yaratmasını) istəməyə bənzəyir.

QOY

PUT sorğusu, API -yə əvvəllər yaradılmış bir şeyi yeniləməyi söyləməyinizdir. Bu, Slash -dan qazdığı çuxura daha dərindən qazılmasını (yeniləməsini) istəməyə bənzəyir.

SİLİN

DELETE sorğusu, API -yə əvvəllər yaradılmış bir şeyi silməyi söyləməyinizdir. Bu, Slash -in əvvəllər qazdığı bir çuxuru ört -basdır etməsini (silməsini) istəməsinə bənzəyir.

Bu dörd növ haqqında düşünün. Məlumat alırsınız, yeni bir giriş yaradırsınız, mövcud bir girişi dəyişdirirsiniz və ya birini silirsiniz? Bu cavab sizə tam olaraq hansı sorğu növünün lazım olduğunu bildirir.

Addım 5: Parametrləri anlayın

Bir çox sorğu əlavə parametrlər tələb edir. Parametrlər, sorğunuzun detallarıdır. Məsələn, Slash -in sizə qırmızı olan bütün topları gətirməsini istəyirsinizsə, rəngi göstərməlisiniz. Yeni bir çuxur yaratmasını istəyirsənsə, onu hara qoyacağını və nə qədər dərin qazacağını deməlisən.

İstinad etdiyiniz API sənədlərində hər bir son nöqtə və sorğu növü üçün "Parametrlər" və ya "Seçimlər" adlı bir bölmə olmalıdır. Bəziləri isteğe bağlı olduğundan hansı parametrlərin tələb olunduğuna diqqət yetirin. Bir parametr isteğe bağlı olaraq qeyd olunarsa, sənədlər həm də standart olan bir nümunə təqdim edə bilər.

Topların alınması üçün Slash -in API parametrləri belə görünə bilər:

Https://slashtheapidog.com/api/balls əldə edin

Addım 6: İstəyinizi Formatlayın

Ehtiyac duyduğumuz bütün məlumatlara sahibik, indi yalnız sorğu etməliyik!

Kod tələb etməyən bir API -yə qoşulmağın iki fərqli yolu var. Https://slashtheapidog.com/api/balls ünvanına GET sorğusu göndərərək top siyahısını əldə etmək üçün Slash -in API -sinə qoşulaq.

Parabola - kod olmadan məlumatlara qoşulmaq və onlarla işləmək istəyirsinizsə

Parabola, API-lərə asanlıqla qoşulmağa və sonra əyani, sürüklə-buraxma vasitəsi ilə məlumatlarla işləməyə imkan verən bir veb tətbiqidir.