API -ga kodsiz ulaning: 8 qadam

2024 Muallif: John Day | [email protected]. Oxirgi o'zgartirilgan: 2024-01-30 13:23

Ushbu qo'llanma API -ni ishlatishni talab qiladigan, lekin qanday boshlashni aniq bilmaydigan odamlar uchun mo'ljallangan. Siz API bilan ishlash nima uchun foydali ekanligini allaqachon bilasiz va bu ko'rsatma sizga buni qanday qilishni ko'rsatib beradi.

Agar bu sizga o'xshasa, omad sizga kulib boqadi! Biz API bilan qanday ishlashni, API hujjatlarini o'qishni va APIdan keladigan ma'lumotlarni qanday ishlatishni tushuntirish uchun keldik.

Biz sayohatni osonlashtirish uchun do'stimizni olib keldik.

Slash bilan tanishing

Slash - Mishelning ajoyib, sevimli iti (yuqoridagi rasmda). Mishel - API yaratuvchi dasturiy injener. Mishel o'z ishidan chindan ham zavq oladi va Slash -ni o'rgatishda o'zining API -larini yaratishda ilhom oladi.

Ma'lumki, API - bu foydalanuvchi veb -xizmatga berishi mumkin bo'lgan buyruqlar to'plami va so'rovga mos keladigan javoblar to'plami. Mishel Slashni xuddi shunday qilishga o'rgatgan. Slash - yaxshi bola, har xil buyruqlarni biladi va siz unga o'rgatilgan so'rovni berganingizda, har doim to'g'ri javob beradi. Qachonki, u yanada hayajonlansa, dumi aqldan ozadi - bu Mishel unga API -lar bilan bog'liq narsa emas, bu uning sevimli mushukchasi va mashg'ulotidan juda xursand bo'lgani uchun!

1 -qadam: Sizga kerak bo'lgan API -ni tanlang

Siz qanday ma'lumotlarni qidirmoqchisiz yoki o'zgartirmoqchimisiz?

@Dougthepug -ning Instagramdagi barcha xabarlarini olishga harakat qilyapsizmi? Ehtimol, siz itingizning tvitteriga ergashgan har bir kishiga avtomatik ravishda tvit yozishni xohlaysiz (chunki itlar gapirolmasa ham, ular ko'p gapirishlari kerak, biz bilamizki, Slash albatta shunday qiladi).

Agar siz allaqachon ulanmoqchi bo'lgan sayt yoki API -ni bilsangiz, to'g'ridan -to'g'ri 2 -bosqichga o'ting. Agar siz ma'lumotlarni qidirmoqchi bo'lsangiz, lekin qaerdan boshlashni bilmasangiz, Google sizning do'stingizdir. "[Sizni qiziqtirgan narsalar] API" ni qidiring va nima bo'lishini ko'ring. U erda qancha ma'lumot borligiga hayron bo'lishingiz mumkin.

Agar siz oddiy API misolini xohlasangiz, Slash -ni o'qitish paytida Mishel tomonidan yaratilganidan foydalanishingiz mumkin. Uning to'plarni olish va teshik qazish kabi sevimli buyruqlari bor. Qolgan misollarimizda biz undan foydalanamiz.

2 -qadam: API hujjatlarini toping

Taniqli kompaniyalar tomonidan taqdim etilgan API-larda ulardan foydalanish bo'yicha to'liq hujjatlar bo'lishi kerak.

Buni topish uchun google "[Insert Company] API hujjatlari" yoki "[Insert Company] developer".

Natijalar sizni ishlab chiquvchilar portaliga olib borishi kerak. "Hujjatlar", "Hujjatlar", "Ma'lumotnoma" yoki "Texnik ma'lumotnoma" yozilgan havolani qidiring.

Hujjatlarda siz xohlagan API -ni qidirishingiz kerak bo'lishi mumkin, chunki ba'zida ko'p variantlar bo'lishi mumkin. Masalan, Facebook -da marketing, reklama, sahifalar va boshqalar uchun alohida API -lar mavjud.

Agar siz ulanmoqchi bo'lgan API (Slash kabi) yaxshi ma'lum bo'lmasa, siz ishlab chiquvchidan hujjatlarni so'rashingiz kerak bo'ladi. Ular sizga kerakli ma'lumotlarni o'z ichiga olgan PDF yoki veb -saytida ko'rsatilmagan onlayn hujjatlar bo'lishi mumkin.

Agar siz oldingi bosqichda havolani o'tkazib yuborgan bo'lsangiz, Slash API hujjatlarini bu erda topishingiz mumkin.

3 -qadam: Oxirgi nuqtani toping

API hujjatlari qo'rqinchli ko'rinishi mumkin, lekin nima qidirishni bilganingizdan so'ng, ular odatda yaxshi tuzilgan va standartlashtirilgan.

Qidirish kerak bo'lgan birinchi narsa - tegishli oxirgi nuqta. Har bir ma'lumot turiga mos keladigan bitta oxirgi nuqta bo'lishi kerak. Oxirgi nuqta quyidagicha ko'rinishi mumkin:

slashtheapidog.com/api/bones/{id}

yoki shunchaki

/suyaklar

Hujjatda oxirgi nuqtalar ro'yxati bo'lishi kerak. Ular hujjatlarda yoki "mos yozuvlar", "so'nggi nuqtalar" yoki "usullar" bo'limi ostida bo'lishi mumkin. To'g'ri so'nggi nuqtani topish uchun siz qidirayotgan ma'lumotlarga mos keladigan nomni qidiring. Masalan, agar siz Slash qazilgan barcha teshiklar ro'yxatini xohlasangiz, /teshiklar, ehtimol, to'g'ri. Qanday bo'lmasin, har bir so'nggi nuqtada nima qilish kerakligini tushuntirishga yordam beradigan tavsif bo'lishi kerak.

Uning hujjatlaridan, bu teshiklar bilan bog'liq Slash API -ning so'nggi nuqtalari:

Https://slashtheapidog.com/api/holes saytiga kiring

Https://slashtheapidog.com/api/holes/{id} saytiga kiring

Https://slashtheapidog.com/api/holes

Https://slashtheapidog.com/api/holes/{id} ni qo'ying

POST

4 -qadam: Sizning so'rov turini aniqlang

Endi siz to'g'ri tugatish nuqtasini topdingiz, uni yuborish uchun so'rov turini aniqlashingiz kerak.

4 xil turdagi so'rovlar mavjud:

Oling

GET so'rovi - bu API -dan, odatda, ma'lumotlarga ega bo'lgan narsaga javob berishni so'rash. Oxirgi nuqta va parametrlarga asoslangan bitta element yoki elementlar guruhi haqida aniq ma'lumot so'rashingiz mumkin. Bu Slashdan sizga bitta suyagini yoki butun suyaklarini olib kelishini so'rash bilan barobar.

POST

POST so'rovi - bu API -ga qanday qilib yangi narsa yaratishni aytishingiz. Bu Slashdan siz uchun yangi teshik qazishni so'rashga o'xshaydi.

QOYISH

PUT so'rovi - bu API -ga ilgari yaratilgan narsani yangilashini aytadi. Bu Slashdan o'zi qazgan teshikni chuqurroq qazishni (yangilashni) so'rashga o'xshaydi.

O'CHIRISH

O'chirish so'rovi - bu API -ga ilgari yaratilgan narsalarni o'chirishni buyurish. Bu Slashdan ilgari qazilgan teshikni yopishni (o'chirishni) so'rashga o'xshaydi.

Bu to'rt tur haqida o'ylab ko'ring. Siz ma'lumot olasizmi, yangi yozuv yaratasizmi, mavjud yozuvni o'zgartirasizmi yoki o'chirasizmi? Bu javob sizga aynan qaysi turdagi so'rov kerakligini aytadi.

5 -qadam: Parametrlarni tushunish

Ko'p so'rovlar qo'shimcha parametrlarni talab qiladi. Parametrlar - bu sizning so'rovingiz tafsilotlari. Masalan, agar siz Slash sizga qizil rangdagi barcha to'plarni olib kelishini xohlasangiz, rangni belgilashingiz kerak. Agar siz uning yangi teshik ochishini xohlasangiz, uni qaerga qo'yish kerakligini va qanchalik chuqur qazishni aytishingiz kerak.

Siz havola qilayotgan API hujjatlarida har bir oxirgi nuqta va so'rov turi uchun "Parametrlar" yoki "Tanlovlar" bo'limi bo'lishi kerak. Qaysi parametrlar talab qilinishiga e'tibor bering, chunki ba'zilari ixtiyoriy. Agar parametr ixtiyoriy deb belgilansa, hujjatlar namunali bo'lishi mumkin, bu ham standart.

Slash API parametrlari to'plarni olish uchun shunday ko'rinishi mumkin:

Https://slashtheapidog.com/api/balls saytini oling

6 -qadam: Sizning so'rovingizni formatlash

Bizda kerakli ma'lumotlar bor, endi biz faqat so'rov yuborishimiz kerak!

Hech qanday kod talab qilmaydigan API -ga ulanishning ikki xil usuli. Keling, https://slashtheapidog.com/api/balls ga GET so'rovini yuborib, uning to'plari ro'yxatini olish uchun Slash API -ga ulanamiz.

Parabola - agar siz kodsiz ma'lumotlarga ulanishni va ular bilan ishlashni xohlasangiz

Parabola-bu veb-ilova bo'lib, u sizga API-larga osonlik bilan ulanishga, so'ngra vizual, sudrab olib tashlash vositasi orqali ma'lumotlar bilan ishlashga imkon beradi.