Csatlakozás API -khoz kód nélkül: 8 lépés

2025 Szerző: John Day | [email protected]. Utoljára módosítva: 2025-01-23 14:47

Ez az útmutató azoknak készült, akik szeretnének valamit elérni, ami API használatát igényli, de nem biztosak benne, hogyan kezdjenek hozzá. Már tudja, miért hasznos az API -val való munka, és ez az útmutató megmutatja, hogyan kell ezt megtenni.

Ha ez úgy hangzik, mint te, akkor szerencséd van! Azért vagyunk itt, hogy elmagyarázzuk, hogyan kell dolgozni az API -kkal, hogyan kell olvasni az API -dokumentumokat, és hogyan kell ténylegesen használni az API -ból származó adatokat.

Elhoztunk egy barátot, hogy könnyebb legyen az utazás.

Ismerje meg Slash -t

Slash Michelle imádnivaló, szerethető kutyája (a fenti képen). Michelle szoftvermérnök, aki API -kat készít. Michelle nagyon élvezi a munkáját, és inspirációt merített a Slash képzésében az API -k építéséből.

Mint talán tudja, az API olyan parancsok gyűjteménye, amelyeket a felhasználó adhat egy webszolgáltatásnak, valamint a kérésnek megfelelő válaszok. Michelle ugyanezt megtanította Slash -re. Slash jó fiú, ismeri a különféle parancsokat, és mindig helyesen válaszol, amíg felkérést ad neki. Amikor extra izgatott lesz, a farka megőrül - ezt Michelle nem tanította meg az API -kkal kapcsolatban, hanem csak azért, mert szerethető kölyök, és nagyon élvezi a képzést!

1. lépés: Döntse el, hogy milyen API -ra van szüksége

Milyen információkat keres vagy szeretne változtatni?

Megpróbálod megragadni @dougthepug összes Instagram -bejegyzését? Talán azt szeretné, ha automatikusan tweetelne bárkinek, aki követi a kutya twitterét (mert bár a kutyák nem tudnak beszélni, sok mondanivalójuk van, tudjuk, hogy Slash biztosan).

Ha már ismeri azt a webhelyet vagy API -t, amelyhez csatlakozni szeretne, folytassa közvetlenül a 2. lépéssel. Ha adatokat keres, de nem tudja, hol kezdje, a Google a barátja. Keresse meg a "[téged érdekli] API" kifejezést, és nézd meg, mi fog megjelenni. Meglepődhet, hogy mennyi információ áll rendelkezésre.

Ha szeretne egy egyszerű példa -API -t, használhatja a Michelle -t, amelyet a Slash edzése során készített. Van néhány kedvenc parancsa, például labdák előhívása és lyukak ásása. Ezt fogjuk használni a többi példánkban.

2. lépés: Keresse meg az API -dokumentumokat

A jól ismert vállalatok által biztosított API-knak alapos dokumentációval kell rendelkezniük a használatukról.

Ezek megtalálásához keresse meg a google "[Insert Company] API dokumentációját" vagy "[Insert Company] fejlesztőt".

Az eredményeknek el kell vezetniük a fejlesztői portálra. Keresse meg a "Dokumentumok", "Dokumentáció", "Referencia" vagy "Műszaki hivatkozás" linket.

A dokumentumokban előfordulhat, hogy meg kell keresnie a kívánt API -t, mivel néha sok lehetőség közül választhat. A Facebook például külön API -kkal rendelkezik a marketinghez, hirdetésekhez, oldalakhoz stb.

Ha az API, amelyhez csatlakozni szeretne, nem ismert (mint például a Slash), előfordulhat, hogy dokumentációt kell kérnie a fejlesztőtől. Előfordulhat, hogy a PDF tartalmazza a szükséges információkat, vagy online dokumentációt tartalmaz, amely nem szerepel a webhelyükön.

Ha elfelejtette a linket az előző lépésben, a Slash API -dokumentumai itt találhatók.

3. lépés: Keresse meg a végpontot

Az API -dokumentumok félelmetesnek tűnhetnek, de ha már tudja, mit keressen, általában jól felépített és meglehetősen szabványosított.

Az első dolog, amit keresni kell, a megfelelő végpont (ok). Minden kívánt adattípusnak egy végpontnak kell lennie. A végpont így nézhet ki:

slashtheapidog.com/api/bones/{id}

vagy csak

/csontok

A dokumentációnak tartalmaznia kell a végpontok listáját. A dokumentumok legfelső szintűek lehetnek, vagy a „referencia”, „végpontok” vagy „metódusok” című szakasz alatt találhatók. A megfelelő végpont megtalálásához keresse meg a keresett adatoknak megfelelő nevet. Például, ha listát szeretne kapni a Slash által ásott összes lyukról, a /hole valószínűleg a megfelelő. Mindenesetre minden végpontnak tartalmaznia kell egy leírást, amely segít megmagyarázni, mit tesz.

Dokumentumai szerint ezek a Slash API lyukakkal kapcsolatos végpontjai:

LETÖLTHETŐ

LETÖLTHETŐ

POSTA

PUT

POSTA

4. lépés: Határozza meg a kérés típusát

Most, hogy megtalálta a megfelelő végpontot, meg kell határoznia a küldeni kívánt kérelem típusát.

4 különböző típusú kérés létezik:

KAP

A GET kérés az, hogy hogyan kéri az API -t, hogy válaszoljon valamivel, ami van, leggyakrabban adatokkal. A végpont és a paraméterek alapján konkrét információkat kérhet egy elemről vagy elemcsoportról. Ez egyenértékű azzal, ha megkérem Slasht, hogy hozza el az egyik csontját vagy az összes csontját.

POST

A POST kérés az, hogy hogyan utasítja az API -t, hogy hozzon létre valami újat. Ez hasonlít ahhoz, hogy megkérje Slash -t, hogy ásson (hozzon létre) egy új lyukat az Ön számára.

PUT

A PUT kérés az, hogy hogyan mondja meg az API -nak, hogy frissítse a korábban létrehozott valamit. Ez hasonlít ahhoz, hogy megkérje Slasht, hogy ásson mélyebbre (frissítsen) az ásott lyukba.

TÖRÖL

A TÖRLÉS kérés az, ahogy utasítja az API -t, hogy töröljön valamit, amit korábban létrehoztak. Ez hasonlít ahhoz, hogy megkérje Slash -t, hogy takarja el (törölje) a korábban ásott lyukat.

Gondoljon erre a négy típusra. Információt szerez, új bejegyzést hoz létre, módosít egy meglévőt vagy törli? Ez a válasz pontosan megmondja, hogy milyen típusú kérésre van szüksége.

5. lépés: Ismerje meg a paramétereket

Sok kérés további paramétereket igényel. A paraméterek a kérés részletei. Például, ha azt szeretné, hogy a Slash hozza meg az összes piros golyót, meg kell adnia a színét. Ha azt akarja, hogy új lyukat hozzon létre, meg kell mondania neki, hová tegye, és milyen mélyre kell ásnia.

Az Ön által hivatkozott API -dokumentációnak tartalmaznia kell egy "Paraméterek" vagy "Beállítások" nevű részt minden végpontra és kéréstípusra. Ügyeljen arra, hogy mely paraméterekre van szükség, mivel néhány opcionális. Ha egy paraméter opcionálisként van megjelölve, akkor a dokumentumok példaként szolgálhatnak, amely szintén alapértelmezett.

A Slash API -paraméterei így nézhetnek ki a golyók lekérésekor:

LETÖLTHETŐ

6. lépés: Formázza meg kérését

Minden szükséges információ megvan, most csak meg kell adnunk a kérést!

Itt kétféle módon csatlakozhat egy API -hoz, amely nem igényel kódot. Csatlakozzunk a Slash API -jához, hogy lekérjük a golyóinak listáját, ha GET kérést küldünk a https://slashtheapidog.com/api/balls címre.

Parabola - ha kód nélküli adatokhoz szeretne csatlakozni és dolgozni

A Parabola egy webalkalmazás, amely lehetővé teszi, hogy könnyen csatlakozzon az API-khoz, majd dolgozzon az adatokkal egy vizuális, drag-and-drop eszköz segítségével.