APIгүйгээр кодгүйгээр холбогдоно уу: 8 алхам

2024 Зохиолч: John Day | [email protected]. Хамгийн сүүлд өөрчлөгдсөн: 2024-01-30 11:01

Энэхүү гарын авлага нь API ашиглах шаардлагатай, гэхдээ хэрхэн яаж эхлүүлэхээ сайн мэдэхгүй байгаа хүмүүст зориулагдсан болно. API -тай ажиллах нь яагаад ашигтай болохыг та аль хэдийн мэдэж байгаа бөгөөд энэ гарын авлагад үүнийг хэрхэн яаж хийхийг зааж өгөх болно.

Хэрэв энэ нь чам шиг санагдаж байвал аз таарна! API -тэй хэрхэн ажиллах, API документыг хэрхэн унших, API -аас буцаж ирсэн өгөгдлийг хэрхэн ашиглах талаар тайлбарлахын тулд бид энд байна.

Аялал жуулчлалыг хөнгөвчлөхийн тулд бид найзыгаа дагуулж ирлээ.

Слэштэй танилцана уу

Slash бол Мишелийн хөөрхөн, дур булаам нохой юм (дээрх зураг дээр). Мишель бол API бүтээдэг програм хангамжийн инженер юм. Мишель ажилдаа үнэхээр дуртай бөгөөд Slash -ийг сургахдаа өөрийн API бүтээх API -ээс санаа авсан.

Таны мэдэж байгаагаар API бол хэрэглэгчийн вэб үйлчилгээнд өгч болох командын цуглуулга бөгөөд хүсэлтэд нийцсэн хариултуудын багц юм. Мишель Slash -ийг яг ийм зүйл хийхийг сургасан. Слаш бол сайн хүү, янз бүрийн тушаалуудыг мэддэг, түүнд зааж өгсөн хүсэлтийг өгсөн л бол үргэлж зөв хариулдаг. Түүнийг илүү их хөөрөхөд сүүл нь галзуурдаг - энэ бол Мишелийн API -тэй холбоотой зүйл биш, харин тэр үнэхээр хайртай зулзага бөгөөд бэлтгэлдээ үнэхээр дуртай болохоор тэр юм!

Алхам 1: Танд ямар API хэрэгтэй болохыг шийдээрэй

Та ямар мэдээлэл хайж байна, эсвэл өөрчлөхийг хүсч байна уу?

Та @dougthepug -ийн инстаграм дээрх бүх бичлэгийг авахыг оролдож байна уу? Та нохойныхоо твиттерийг дагаж буй хэн нэгэнд автоматаар жиргэхийг хүсч магадгүй юм (хэдийгээр нохой ярьж чаддаггүй ч тэдэнд хэлэх зүйл маш их байдаг, бид Slash -ийг үнэхээр мэддэг гэдгийг мэддэг).

Хэрэв та холбогдох гэж байгаа сайт эсвэл API -г аль хэдийн мэддэг бол 2 -р алхам руу шууд очно уу. Хэрэв та өгөгдөл олох гэж байгаа боловч хаанаас эхлэхээ мэдэхгүй байгаа бол Google бол таны найз. "[Таны сонирхож буй зүйл] API" -ийг хайж олоод юу болохыг хараарай. Тэнд хэр их мэдээлэл байгааг та гайхаж магадгүй юм.

Хэрэв та API -ийн энгийн жишээг хүсч байвал Slash -ийг сургахдаа Мишелийг ашиглаж болно. Энэ нь бөмбөг авах, нүх ухах гэх мэт дуртай командуудтай. Бид үүнийг үлдсэн жишээнүүддээ ашиглах болно.

Алхам 2: API баримт бичгийг хайж олох

Нэр алдартай компаниудын өгсөн API нь тэдгээрийг хэрхэн ашиглах талаар нарийвчилсан баримт бичигтэй байх ёстой.

Эдгээрийг олохын тулд google "[Insert Company] API document" эсвэл "[Insert Company] developer".

Үр дүн нь таныг хөгжүүлэгчийн портал руу оруулах ёстой. "Docs", "Documentation", "Reference" эсвэл "Technical Reference" гэсэн холбоосыг хайж олоорой.

Баримт бичгийн дотроос та хүссэн API -г хайх хэрэгтэй болж магадгүй тул заримдаа олон сонголт байж болно. Жишээлбэл, Facebook нь маркетинг, зар сурталчилгаа, хуудас гэх мэт тусдаа API -тай байдаг.

Хэрэв таны холбохыг хүсч буй API нь тийм ч сайн танигдаагүй бол (Slash -ийнх шиг) та хөгжүүлэгчээс бичиг баримт шаардах хэрэгтэй болж магадгүй юм. Тэд танд хэрэгтэй мэдээлэл эсвэл вэбсайтдаа ороогүй онлайн баримт бичгийг агуулсан PDF файлтай байж болно.

Хэрэв та өмнөх алхам дээр линкийг алдсан бол Slash -ийн API документыг эндээс олж болно.

Алхам 3: Эцсийн цэгийг олох

API docs нь аймшигтай харагдаж магадгүй, гэхдээ юу хайхаа мэддэг болсны дараа тэдгээр нь ихэвчлэн сайн бүтэцтэй, нэлээд стандартчилагдсан байдаг.

Хайх ёстой хамгийн эхний зүйл бол тохирох төгсгөлийн цэгүүд юм. Таны хүссэн өгөгдлийн төрөл тус бүрт харгалзах нэг төгсгөлийн цэг байх ёстой. Эцсийн цэг дараах байдлаар харагдаж болно.

slashtheapidog.com/api/bones/{id}

эсвэл зүгээр л

/яс

Баримт бичигт эцсийн цэгүүдийн жагсаалт байх ёстой. Тэдгээр нь дээд түвшний баримт бичигт эсвэл "лавлагаа", "төгсгөлийн цэгүүд" эсвэл "аргууд" гэсэн хэсгийн дор байж болно. Зөв төгсгөлийн цэгийг олохын тулд хайж буй өгөгдөлтэйгээ тохирох нэрийг хайна уу. Жишээлбэл, хэрэв та Slash -ийн ухсан бүх нүхний жагсаалтыг авахыг хүсч байвал /нүх нь зөв байх магадлалтай. Ямар ч тохиолдолд эцсийн цэг бүр нь юу хийж байгаагаа тайлбарлахад туслах тайлбартай байх ёстой.

Түүний баримтуудаас эдгээр нь нүхтэй холбоотой Slash API -ийн төгсгөлийн цэгүүд юм.

Https://slashtheapidog.com/api/holes авах

Https://slashtheapidog.com/api/holes/{id} авах

Https://slashtheapidog.com/api/holes байрлуулах

Https://slashtheapidog.com/api/holes/{id} оруулах

Https://slashtheapidog.com/api/holes/{id} БИЧИХ

Алхам 4: Хүсэлтийнхээ төрлийг тодорхойл

Та зөв төгсгөлийн цэгийг олсон тул түүнийг илгээх хүсэлтийн төрлийг тодорхойлох хэрэгтэй.

4 төрлийн хүсэлт байдаг:

АВАХ

GET хүсэлт бол ихэнхдээ өгөгдөлд байгаа ямар нэгэн зүйлээр хариу өгөхийг API -аас хэрхэн яаж хүсэх явдал юм. Та эцсийн цэг, параметрүүд дээр үндэслэн нэг зүйл эсвэл бүлгийн зүйлийн талаар тодорхой мэдээлэл авах боломжтой. Энэ нь Слашаас нэг яс эсвэл бүх ясыг нь авчрахыг хүссэнтэй дүйцэхүйц юм.

POST

POST хүсэлт бол API -д хэрхэн шинэ зүйл хийхийг хэлж өгөх явдал юм. Энэ нь Slash -аас танд зориулж шинэ нүх ухаж өгөхийг хүсч байгаатай адил юм.

PUT

PUT хүсэлт бол өмнө нь үүсгэсэн зүйлийг шинэчлэхийг API -д хэрхэн хэлэхийг хэлнэ. Энэ нь Слашаас ухсан нүхээ гүнзгий ухаж (шинэчлэх) асуухтай адил юм.

УСТГАХ

DELETE хүсэлт нь API -д өмнө нь үүсгэсэн зүйлийг устгахыг хэлж өгөх явдал юм. Энэ нь Slash -ээс өмнө нь ухсан нүхийг далдлах (устгах) хүсэхтэй адил юм.

Эдгээр дөрвөн төрлийг бодоорой. Та мэдээлэл авч байна уу, шинэ оруулга үүсгэж байна уу, одоо байгаа оруулгыг өөрчилж байна уу эсвэл устгаж байна уу? Энэ хариулт нь танд яг ямар төрлийн хүсэлт хэрэгтэйг хэлж өгнө.

Алхам 5: Параметрүүдийг ойлгох

Олон хүсэлт нэмэлт параметрүүдийг шаарддаг. Параметрүүд нь таны хүсэлтийн дэлгэрэнгүй мэдээлэл юм. Жишээлбэл, хэрэв та Slash улаан өнгийн бүх бөмбөгийг танд авчрахыг хүсч байвал өнгийг нь зааж өгөх хэрэгтэй. Хэрэв та түүнийг шинэ нүх бий болгохыг хүсч байвал түүнийг хаана байрлуулах, хэр гүн ухах ёстойг хэлэх хэрэгтэй.

Таны лавлаж буй API баримт бичигт төгсгөлийн цэг, хүсэлтийн төрөл тус бүрийн хувьд "Параметрүүд" эсвэл "Сонголтууд" гэсэн хэсэг байх ёстой. Зарим нь заавал биш тул ямар параметр шаардлагатай байгааг анхаарч үзээрэй. Хэрэв параметрийг заавал биш гэж тэмдэглэсэн бол docs нь бас анхдагч болох жишээг өгч болно.

Slash -ийн API параметрүүд бөмбөг авахад иймэрхүү харагдаж магадгүй юм.

Https://slashtheapidog.com/api/balls авах

Алхам 6: Хүсэлтээ форматлана уу

Бидэнд хэрэгтэй бүх мэдээлэл байгаа, одоо бид зөвхөн хүсэлт гаргах ёстой!

Код оруулах шаардлагагүй API -тай холбогдох хоёр өөр аргыг энд оруулав. Https://slashtheapidog.com/api/balls хаягаар GET хүсэлт гаргаж бөмбөгнүүдийн жагсаалтыг авахын тулд Slash -ийн API -тай холбогдъё.

Парабола - хэрэв та кодгүйгээр өгөгдөлтэй холбогдох, түүнтэй ажиллахыг хүсч байвал

Парабола бол API-тэй хялбархан холбогдох боломжийг олгодог вэб програм бөгөөд дараа нь визуал, чирэх хэрэгсэл ашиглан өгөгдөлтэй ажиллах боломжтой.