Čo je to REST API a ako môžete získať údaje pre svoju aplikáciu alebo webovú stránku?

Skratka API znamená rozhranie pre programovanie aplikácií. An API je sada funkcií, ktoré uľahčujú komunikáciu medzi dvoma softvérovými aplikáciami. V podstate an API prevezme požiadavku z jednej softvérovej aplikácie do druhej a potom sa vráti k inicializačnému softvéru s príslušnou odpoveďou.

ODPOČÍVAJTE znamená prenos reprezentatívneho stavu a je to architektúra používaná na navrhovanie aplikácií klient-server. S Rest API, získate reprezentáciu požadovaných údajov uložených v databáze. A REST API je tiež bez štátnej príslušnosti, čo znamená, že server neuchováva žiadne údaje medzi požiadavkami klientov.

Ak hľadáte a Rest API príklad a podrobné vysvetlenie, ako to funguje, čítajte ďalej.

Ako funguje REST API?

A REST API pristupuje k údajom prostredníctvom jednotných identifikátorov zdrojov (URI), čo je reťazec znakov, ktoré identifikujú konkrétny zdroj. Typ URI používaný a REST API je jednotný vyhľadávač zdrojov (URL).

Na prístup k zdrojom a manipuláciu s nimi REST API používa nasledujúce slovesá požiadaviek:

• Získať (používa sa na získavanie údajov z databázy)
• Odoslať (pridať nové údaje do databázy)
• Vložte (aktualizujte údaje v databáze)
• Odstrániť (vymazať údaje z databázy)

Ak chcete využiť služby jednej z mnohých REST API k dispozícii na webe (namiesto toho, aby ste ho budovali od začiatku), budete mať prístup iba k slovesu získania žiadosti REST API (prostredníctvom adresy URL). Tieto adresy URL majú niekoľko komponentov, ale tie, ktoré potrebujete vedieť, sú API kľúč a dotaz.

The API key je jedinečný identifikátor, ktorý obdržíte po registrácii na serveri REST API plošina. Dotaz je zvyčajne jednoduchá rovnica používaná na prispôsobenie vášho vyhľadávania. Ak by ste teda chceli zistiť aktuálne počasie v meste New York, časť dopytu vašej adresy URL môže byť „mesto = New York“.

Vykonanie žiadosti o získanie vráti odpoveď, ktorá obsahuje stavový kód a telo. Ak je žiadosť úspešná, váš orgán reakcie bude obsahovať údaje, ktoré chcete použiť na svojom webe alebo aplikácii.

Použitie aplikácie JavaScript na získavanie údajov z rôznych rozhraní API Rest

Na zostavenie tejto jednoduchej aplikácie musíte do počítača nainštalovať dve ďalšie softvérové ​​aplikácie: NodeJS a npm. Napísali sme článok o inštalácii NodeJS a npm na Ubuntu, ako aj jeden na ako to urobiť v systéme Windows- Ak sa chcete dozvedieť viac, pozrite sa na ne.

Po nainštalovaní vyššie uvedených aplikácií do počítača budete musieť vykonať nasledujúce kroky:

1. Otvorte IDE a spustite terminál.
2. Prejdite do priečinka obsahujúceho váš súbor aplikácie JavaScript pomocou príkazu cd.
3. Inicializujte npm pomocou nasledujúceho riadku kódu:

npm init -y

Existuje jeden modul npm, ktorý bude hrať kľúčovú úlohu vo funkčnosti tejto aplikácie. Toto je modul got, čo je knižnica požiadaviek HTTP pre NodeJS. Nasledujúci riadok kódu nainštaluje najnovšiu verziu získanej knižnice do vašich súborov aplikácie:

npm install got@latest

Teraz môžete pokračovať a vytvoriť svoju aplikáciu.

Použitie knižnice Got na zostavenie vašej aplikácie

// importujte získanú knižnicu do svojej aplikácie
const got = require ('got');
// načítanie údajov z konkrétneho REST API a vytlačenie jeho tela na terminál
(async () => {
skúsiť {
const response = await got (URL);
const data = JSON.parse (response.body);
console.log (údaje);
} catch (chyba) {
console.log (error.data);
}
})();

Vyššie uvedená aplikácia zachytí údaje z ľubovoľného REST API na webe. Najprv však budete musieť zadať adresu URL príslušného zdroja.

Získavanie údajov z API REST pre počasie

Web Weatherbit.io API je jedno z najobľúbenejších počasie REST API. Vkladanie URL tejto adresy API do jednoduchej aplikácie JavaScript vyššie uvedie aplikáciu do prevádzky.

Použitie REST API Weatherbit.io

// importujte získanú knižnicu do svojej aplikácie
const got = require ('got');
// načítanie údajov z konkrétneho REST API a vytlačenie jeho tela na terminál
(async () => {
skúsiť {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40,7128 & lon = -74,0000 & key = API_KEY ';
const response = await got (URL);
const data = JSON.parse (response.body);
console.log (údaje);
} catch (chyba) {
console.log (error.data);
}
})();

Adresa URL pre Weatherbit.io API je teraz úspešne vložený do aplikácie. Existuje však jeden aspekt adresy URL, ktorý musíte upraviť, aby bola aplikácia spustená. Toto je sekcia označená „API_KEY“ a tento kľúč získate od webu Weatherbit.io, keď sa zaregistrujete na bezplatný účet.

Vo vyššie uvedenom kóde máte tiež možnosť upraviť sekciu dotazu. Aplikácia aktuálne zisťuje počasie na 40,7128 zemepisnej šírky a -74,0060 na zemepisnú dĺžku, ale môžete vložiť nové súradnice. Napriek tomu, že vyššie uvedený dotaz je odporúčaným prístupom, môžete počasie vyhľadať na mieste pomocou názvu mesta.

Viac informácií o tom, ako používať web Weatherbit.io REST API, kliknite tu.

Po vložení vášho API kľúč v príslušnej sekcii vyššie, teraz môžete spustiť svoj súbor JavaScript. Aplikácia vo vašom termináli dodá niečo podobné nasledujúcemu výstupu.

Weatherbit.io Príklad odpovede API REST

údaje: [
{
rh: 53,
pod: 'd',
dĺžka: -74,01,
prez: 1005,9,
časové pásmo: 'Amerika/New_York',
ob_time: '2021-09-27 14:50',
country_code: 'US',
oblaky: 25,
ts: 1632754200,
solar_rad: 652,8,
state_code: 'NY',
city_name: 'New York City',
vietor_spd: 5,66,
wind_cdir_full: 'západ-juhozápad',
wind_cdir: 'WSW',
slp: 1015,9,
vis: 5,
h_angle: -30,
Západ slnka: '22: 44 ',
dni: 851,72,
rosný: 12,
sneh: 0,
uv: 5,68859,
zrážka: 0,
smer vetra: 240,
východ slnka: '10: 49 ',
ghi: 657,55,
dhi: 106,79,
aqi: 53,
zemepisná šírka: 40,71,
počasie: [objekt],
dátum: '2021-09-27: 14',
teplota: 22,
stanica: 'KJRB',
výškový uhol: 40,89,
app_temp: 21.7
}
],
počítať: 1
}

K niektorým z dôležitejších aspektov údajov vrátených v odpovedi patrí:

• Názov mesta (vráti názov mesta na zadanej zemepisnej dĺžke a šírke).
• Dátum Čas (vráti aktuálnu hodinu cyklu vo formáte RRRR-MM-DD: HH).
• Počasie (vráti objekt obsahujúci ikonu počasia, kód počasia a textový popis počasia).

Získavanie údajov z rozhrania News REST API

Správy API použitá v tejto sekcii je Newsdata.io. Ako všetko REST API na webe poskytuje niekoľko možností dotazov, ktoré môžete použiť na načítanie aktuálnych správ z celého sveta. S webom Newsdata.io API, môžete dostávať správy z konkrétnej krajiny alebo z konkrétneho jazyka, kategórie a podobne.

Pomocou aplikácie JavaScript môžete získavať údaje zo správ REST API. Jednoducho nahraďte adresu URL v aplikácii vyššie nasledujúcou adresou URL:

' https://newsdata.io/api/1/news? apikey = YOUR_API_KEY & country = us '

Ďalším krokom je nahradenie sekcie „YOUR_API_KEY“ na vyššie uvedenej adrese URL príponou API kľúč, ktorý dostanete po registrácii na Newsdata.io. Webová adresa uvedená vyššie vráti najnovšie správy z Ameriky. Ak však chcete správy z Japonska, môžete jednoducho nahradiť dopyt „contry = us“ výrazom „country = jp“.

Viac informácií o tom, ako používať Newsdata.io REST API, kliknite tu.

Súvisiace: Chcete na svoj web alebo aplikáciu pridať titulky správ? Potrebujete rozhranie Mediastack API

Newsdata.io Príklad odpovede API REST

{
názov: „Vodič zabitý vlastnými dverami v aute, keď čakal v rade na ceste rýchlym občerstvením a poskytoval varovné informácie pre samoriadiace autá s umelou inteligenciou“,
odkaz: ' https://www.forbes.com/sites/lanceeliot/2021/09/27/driver-killed-by-his-own-car-door-while-waiting-in-line-at-fast-food-drive-thru-providing-cautionary-insights-for-ai-self-driving-cars/',
kľúčové slová: [pole],
tvorca: [Array],
video_URL: null,
popis: „Smutná správa o vodičovi, ktorého zabili dvere jeho vlastného auta (počas jazdy), ponúka varovné informácie o
nástup samoriadiacich automobilov na báze AI. Tu je pohľad dovnútra. “,
obsah: „Smutná správa o vodičovi, ktorého zabili dvere jeho vlastného auta (počas jazdy), ponúka varovné informácie o
nástup samoriadiacich automobilov na báze AI. Tu je pohľad dovnútra. “,
pubDate: '2021-09-27 15:30:00',
image_URL: ' https://thumbor.forbes.com/thumbor/fit-in/0x0/filters%3Aformat%28jpg%29/https://specials-images.forbesimg.com/imageserve/614272b9f18bec6882652695/0x0.jpg? cropX1 = 23 & cropX2 = 2455 & cropY1 = 23 & cropY2 = 1538 ',
source_id: 'zakazuje'
}

Použitie aplikácie Python na získavanie údajov z rôznych rozhraní API Rest

Údaje pre svoj web alebo aplikáciu je možné získať pomocou ľubovoľného programovacieho jazyka, ktorý poznáte. Ak teda nechcete používať JavaScript, s aplikáciou Python môžete dosiahnuť rovnaké výsledky.

Súvisiace: Ako stavať API v Pythone: Populárne rámce

Všetko, čo musíte urobiť, je nainštalovať modul HTTP python požiadaviek pomocou prostredia pip. Potom môžete svoju aplikáciu Python vytvoriť pomocou nasledujúceho kódu:

# importujte knižnicu požiadaviek
žiadosti o import
# získavanie údajov pomocou knižnice požiadaviek
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = my '
res = requests.get (URL)
json = res.json ()
pre kľúč v json:
tlač (kľúč, json [kľúč])

Podobne ako v predchádzajúcich príkladoch budete musieť vložiť svoj API kľúč v príslušnej sekcii. Potom dostanete tie isté údaje, ktoré aplikácia JavaScript vracia.

Získanie údajov pre váš web alebo aplikáciu je celkom jednoduché

Teraz máte nástroje, ktoré potrebujete na získanie údajov pre svoje softvérové ​​aplikácie. Je dôležité mať na pamäti, že ODPOČÍVAJTE architektúra uľahčuje voľné párovanie, čo znamená, že na získanie údajov z akéhokoľvek môžete použiť akýkoľvek programovací jazyk REST API na webe.

Teraz viete, ako používať Rest API, prečo to neskúsiť?

Škrabanie webu vs. API: Aký je najlepší spôsob získavania údajov?

Všade sú údaje, ale dostať sa do rúk je ďalší problém - ak je to dokonca legálne.

Čítajte ďalej

O autorovi