Připojte se k API bez kódu: 8 kroků

2024 Autor: John Day | [email protected]. Naposledy změněno: 2024-01-30 08:19

Tato příručka je určena lidem, kteří chtějí dosáhnout něčeho, co vyžaduje použití API, ale nejsou si jisti, jak začít. Už víte, proč je užitečné pracovat s API, a tato příručka vám ukáže, jak to udělat.

Pokud to zní jako vy, máte štěstí! Jsme tu, abychom vysvětlili, jak pracovat s rozhraními API, jak číst dokumenty API a jak skutečně používat data přicházející z rozhraní API.

Přivedli jsme s sebou přítele, aby nám cestu hodně usnadnili.

Seznamte se se Slashem

Slash je Michelleův rozkošný a milý pes (na obrázku výše). Michelle je softwarová inženýrka, která vytváří API. Michelle její práce opravdu baví a při výcviku Slash se inspirovala svými API pro budování práce.

Jak možná víte, API je kolekce příkazů, které může uživatel poskytnout webové službě spolu se sadou odpovědí, které odpovídají požadavku. Michelle vycvičila Slasha, aby udělal to samé. Slash je hodný chlapec, zná řadu povelů a vždy odpovídá správně, pokud mu dáte žádost, která ho naučila. Když se extra nadchne, jeho ocas se zblázní - to není něco, co ho Michelle naučila v souvislosti s API, je to jen proto, že je roztomilé štěně a trénink ho opravdu baví!

Krok 1: Rozhodněte se, jaké API potřebujete

Jaké informace hledáte nebo chcete změnit?

Pokoušíte se zachytit všechny příspěvky na Instagramu @dougthepug? Možná budete chtít automaticky tweetovat každému, kdo sleduje twitter vašeho psa (protože i když psi nemohou mluvit, mají co říci, víme, že Slash určitě ano).

Pokud již znáte web nebo rozhraní API, ke kterému se pokoušíte připojit, přejděte přímo ke kroku 2. Pokud se pokoušíte najít data, ale nevíte, kde začít, Google je váš přítel. Vyhledejte „[věci, které vás zajímají] API“a uvidíte, co se objeví. Možná vás překvapí, kolik informací tam je.

Pokud byste chtěli jednoduchý příklad API, můžete použít ten, který vytvořila Michelle při tréninku Slash. Má některé z jeho oblíbených příkazů, jako je získávání míčků a kopání děr. Budeme to používat ve zbytku našich příkladů.

Krok 2: Najděte dokumenty API

API poskytovaná známými společnostmi by měla mít důkladnou dokumentaci o tom, jak je používat.

Chcete -li je najít, vyhledejte si v Google „[Vložit společnost] dokumentaci API“nebo „[Vložit společnost] vývojáře“.

Výsledky by vás měly přenést na portál pro vývojáře. Vyhledejte odkaz „Dokumenty“, „Dokumentace“, „Reference“nebo „Technická reference“.

V dokumentech možná budete muset hledat konkrétní API, které chcete, protože někdy může být mnoho možností. Facebook má například samostatná rozhraní API pro marketing, reklamy, stránky a další.

Pokud API, ke kterému se chcete připojit, není dobře známé (jako Slash's), možná budete muset požádat vývojáře o dokumentaci. Mohou mít PDF obsahující potřebné informace nebo online dokumentaci, která není uvedena na jejich webových stránkách.

Pokud jste v předchozím kroku zmeškali odkaz, dokumenty API Slash najdete zde.

Krok 3: Najděte koncový bod

Dokumenty API mohou vypadat skličující, ale jakmile víte, co hledat, jsou obvykle dobře strukturované a docela standardizované.

První věcí, kterou je třeba hledat, jsou příslušné koncové body. Měl by existovat jeden koncový bod odpovídající každému typu požadovaných dat. Koncový bod může vypadat takto:

slashtheapidog.com/api/bones/{id}

nebo prostě

/kosti

Dokumentace by měla mít seznam koncových bodů. Mohou být na nejvyšší úrovni v dokumentech nebo v sekci nazvané „reference“, „koncové body“nebo „metody“. Chcete -li najít správný koncový bod, vyhledejte název, který odpovídá datům, která hledáte. Pokud například chcete seznam všech děr, které Slash vykopal, /hole je pravděpodobně ten správný. V každém případě by každý koncový bod měl mít popis, který by pomohl vysvětlit, co dělá.

Z jeho dokumentů to jsou koncové body v Slashově API související s otvory:

ZÍSKEJTE

ZÍSKEJTE

POST

VLOŽTE

POST

Krok 4: Určení typu požadavku

Nyní, když jste našli správný koncový bod, musíte určit typ žádosti o jeho odeslání.

Existují 4 různé typy požadavků:

DOSTAT

Požadavek GET je způsob, jakým požádáte rozhraní API, aby odpovědělo něčím, co má, nejčastěji daty. Můžete požádat o konkrétní informace o jedné položce nebo skupině položek na základě koncového bodu a parametrů. To je ekvivalent požadavku, aby vám Slash přinesl jednu z jeho kostí nebo všechny jeho kosti.

POŠTA

Požadavek POST je způsob, jakým řeknete API, aby vytvořilo něco nového. Je to podobné, jako když požádáte Slash, aby vám vykopal (vytvořil) novou díru.

DÁT

Požadavek PUT je způsob, jakým říkáte rozhraní API, aby aktualizovalo něco, co bylo dříve vytvořeno. Je to podobné, jako když Slash požádá, aby se hlouběji (aktualizoval) do díry, kterou vykopal.

VYMAZAT

Požadavek DELETE je způsob, jakým řeknete API, aby odstranilo něco, co bylo dříve vytvořeno. Je to podobné, jako když Slash požádá, aby zakryl (vymazal) díru, kterou předtím vykopal.

Zamyslete se nad těmito čtyřmi typy. Získáváte informace, vytváříte nový záznam, měníte stávající záznam nebo ho mazáte? Tato odpověď vám přesně řekne, jaký typ požadavku potřebujete.

Krok 5: Porozumění parametrům

Mnoho požadavků vyžaduje další parametry. Parametry jsou detaily vašeho požadavku. Pokud například chcete, aby vám Slash přinesl všechny koule, které jsou červené, musíte zadat barvu. Pokud chcete, aby vytvořil novou díru, musíte mu říct, kam ji dát a jak hluboko kopat.

Dokumentace API, na kterou odkazujete, by měla mít sekci nazvanou "Parametry" nebo "Možnosti" pro každý koncový bod a typ požadavku. Věnujte pozornost tomu, jaké parametry jsou vyžadovány, protože některé jsou volitelné. Pokud je parametr označen jako volitelný, dokumenty mohou poskytnout příklad, který je také výchozí.

Parametry API Slash mohou pro načítání koulí vypadat nějak takto:

ZÍSKEJTE

Krok 6: Formátujte svůj požadavek

Máme všechny potřebné informace, nyní stačí podat žádost!

Zde jsou dva různé způsoby připojení k API, které nevyžadují žádný kód. Pojďme se připojit k API Slash a získat jeho seznam míčů odesláním požadavku GET na

Parabola - pokud se chcete připojit k datům a pracovat s nimi bez kódu

Parabola je webová aplikace, která vám umožňuje snadné připojení k API a práci s daty pomocí vizuálního nástroje pro přetahování.