REST API: a helyes elemútvonal (Items path) megtalálása

Ha a REST API-végpont beállításánál piros hibaüzenetet kapsz, az Items path (elemútvonal) mező van rosszul kitöltve. Az útvonal azt mondja meg, hol találhatók az API válaszában az elemek. Ha nem a megfelelő helyre mutat, a végpont nem tud kapcsolódni.

Az alábbi példa két ingyenes API-n mutatja meg, hogyan találhatod meg a helyes útvonalat. Az API-k egy külső API-piactérről (RapidAPI) valók, és mindkettőhöz ingyenes fiók kell ott.

https://minta-bolt.hu/wp-admin/admin.php?page=jet-engine

A végpont felvétele

1. Nyisd meg a JetEngine → REST API-végpontok oldalt, és kattints az új végpont felvételére szolgáló gombra.
2. Az API leírásának Code Snippets füléből másold ki az URL-t, és illeszd az API Endpoint URL mezőbe.
3. Az Items path mezőt egyelőre hagyd üresen.
4. Kapcsold be az Authorization opciót, és válaszd a RapidAPI típust.
5. Az API-piactérről másold ki a kulcsot és a hosztot, és illeszd a RapidAPI Key és a RapidAPI Host mezőbe.
6. Ha az API paramétert kér (a példában term: 'wat'), másold be a Query String mezőbe, és a kettőspontot cseréld egyenlőségjelre: term=wat.

A Query String mező nem kötelező, és nem minden végpontnak kell.

Az Items path megadása

1. Az API leírásában kattints a Test Endpoint gombra.
2. A jobb oldali Results fülön nézd meg a válasz szerkezetét. Ha az elemek egy mappában (kulcs alatt) vannak, az útvonal ennek a kulcsnak a neve. Az említett Urban Dictionary példában az elemek a list kulcs alatt vannak.
3. Írd az Items path mezőbe: /list.
4. Kattints a Send Request gombra. A Connected állapot azt jelzi, hogy a beállítások rendben vannak.
5. Kattints a Save gombra.

Egy másik példa: az ingyenes NBA API végpontjánál az elemek a data kulcs alatt vannak, ott az útvonal /data.

Összefoglalva: ha az URL közvetlenül az elemek listáját adja vissza, az útvonal /. Ha a lista egy kulcs alatt van, írd be a kulcsot, például /list vagy /data.