Kas yra REST API ir kaip galite paimti savo programos ar svetainės duomenis?

Santrumpa API reiškia programų programavimo sąsają. An API yra funkcijų rinkinys, palengvinantis ryšį tarp dviejų programinės įrangos programų. Iš esmės, an API perima užklausą iš vienos programinės įrangos į kitą, tada grįžta į inicijuojančią programinę įrangą ir pateikia atitinkamą atsakymą.

POILSIS reiškia reprezentacinį būsenos perdavimą, ir tai yra architektūra, naudojama kuriant kliento-serverio programas. Su Poilsio APIgausite duomenų bazėje saugomus prašomus duomenis. A REST API taip pat yra be pilietybės, o tai reiškia, kad serveris nesaugo jokių duomenų tarp klientų užklausų.

Jei ieškote a Poilsio API pavyzdys ir išsamus jo veikimo paaiškinimas, skaitykite toliau.

Kaip veikia REST API?

A REST API prieina prie duomenų per vienodus išteklių identifikatorius (URI), tai yra simbolių eilutė, identifikuojanti konkretų išteklių. URI tipas, kurį naudoja a REST API yra vienodas išteklių ieškiklis (URL).

Norėdami pasiekti ir valdyti išteklius, REST API naudoja šiuos užklausos veiksmažodžius:

• Gauti (tai naudojama duomenims iš duomenų bazės gauti)
• Skelbti (pridėti naujų duomenų prie duomenų bazės)
• Įdėkite (atnaujinkite duomenis duomenų bazėje)
• Ištrinti (ištrinti duomenis iš duomenų bazės)

Jei norite pasinaudoti vienos iš daugelio paslaugomis REST API prieinama žiniatinklyje (užuot sukūrusi vieną nuo nulio), turėsite prieigą tik prie užklausos gavimo veiksmažodžio REST API (per URL). Šiuos URL sudaro keli komponentai, tačiau jums reikia žinoti API raktą ir užklausą.

The API raktas yra unikalus identifikatorius, kurį gausite užsiregistravę REST API platforma. Paprastai užklausa yra paprasta lygtis, naudojama jūsų paieškai suasmeninti. Todėl, jei norite sužinoti dabartinį orą Niujorke, URL užklausos skiltis gali būti „miestas = Niujorkas“.

Vykdant gavimo užklausą pateikiamas atsakymas, kuriame yra būsenos kodas ir turinys. Jei užklausa bus patenkinta, atsakymo įstaigoje bus duomenys, kuriuos norite naudoti savo svetainėje ar programoje.

„JavaScript“ programos naudojimas duomenims iš skirtingų poilsio API gauti

Norėdami sukurti šią paprastą programą, kompiuteryje turite įdiegti dar dvi programinės įrangos programas: „NodeJS“ ir „npm“. Mes parašėme straipsnį apie tai, kaip įdiegti „NodeJS“ ir „npm“ „Ubuntu“, taip pat vienas kaip tai padaryti „Windows“- Taigi, jei norite sužinoti daugiau, patikrinkite juos.

Įdiegę aukščiau esančias programas jūsų kompiuteryje, turėsite atlikti šiuos veiksmus:

1. Atidarykite savo IDE ir paleiskite terminalą.
2. Eikite į aplanką, kuriame yra jūsų „JavaScript“ programos failas, naudodami komandą cd.
3. Inicijuokite „npm“ naudodami šią kodo eilutę:

npm init -y

Yra vienas npm modulis, kuris vaidins pagrindinį vaidmenį šios programos funkcijose. Tai modulis „got“, ​​kuris yra „NodeJS“ HTTP užklausų biblioteka. Ši kodo eilutė į jūsų programos failus įdiegs naujausią gautos bibliotekos versiją:

npm įdiegti gavo@naujausią

Dabar galite tęsti ir kurti savo programą.

„Got Library“ naudojimas kuriant programą

// importuokite gautą biblioteką į savo programą
const got = reikalauti ('turiu');
// gauti duomenis iš konkrečios REST API ir išspausdinti jos turinį į terminalą
(async () => {
bandyti {
const response = laukti gautas (URL);
const duomenys = JSON.parse (response.body);
console.log (duomenys);
} pagauti (klaida) {
console.log (error.data);
}
})();

Aukščiau pateikta programa paims duomenis iš bet kurios REST API internete. Tačiau pirmiausia turėsite pateikti atitinkamo šaltinio URL.

Duomenų paėmimas iš „Weather REST“ API

„Weatherbit.io“ API yra vienas populiariausių orų REST API. Įterpiamas šio URL adresas API į aukščiau pateiktą paprastą „JavaScript“ programą, programa veiks.

„Weatherbit.io“ REST API naudojimas

// importuokite gautą biblioteką į savo programą
const got = reikalauti ('turiu');
// gauti duomenis iš konkrečios REST API ir išspausdinti jos turinį į terminalą
(async () => {
bandyti {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
const response = laukti gautas (URL);
const duomenys = JSON.parse (response.body);
console.log (duomenys);
} pagauti (klaida) {
console.log (error.data);
}
})();

Weatherbit.io URL API dabar sėkmingai įterpta į programą. Tačiau yra vienas URL aspektas, kurį turite pakoreguoti, kad programa veiktų. Tai skyrius, pavadintas „API_KEY“, ir šį raktą gausite iš Weatherbit.io, kai užsiregistruosite nemokamai.

Taip pat galite koreguoti aukščiau esančio kodo užklausos skyrių. Programa šiuo metu teiraujasi orų 40.7128 platumos ir -74.0060 ilgumos, tačiau galite įterpti naujas koordinates. Nors aukščiau pateikta užklausa yra rekomenduojamas metodas, galite ieškoti orų vietovėje naudodami miesto pavadinimą.

Norėdami gauti daugiau informacijos apie tai, kaip naudotis Weatherbit.io REST API, paspauskite čia.

Įdėjus savo API įveskite atitinkamą skyrių aukščiau, dabar galite paleisti „JavaScript“ failą. Programa pateiks kažką panašaus į šią terminalo išvestį.

Weatherbit.io REST API atsako pavyzdys

duomenys: [
{
rh: 53,
anketa: „d“,
ilgis: -74,01,
presas: 1005,9,
laiko juosta: „Amerika/Niujorkas“,
ob_time: '2021-09-27 14:50',
country_code: 'JAV',
debesys: 25,
ts: 1632754200,
saulės_radas: 652,8,
state_code: 'NY',
city_name: „Niujorkas“,
vėjo_spd: 5.66,
wind_cdir_full: 'vakarai-pietvakariai',
wind_cdir: 'WSW',
slp: 1015,9,
prieš: 5,
kampas: -30,
saulėlydis: '22: 44 ',
DNR: 851.72,
rasos: 12,
sniegas: 0,
PVM: 5.68859,
krituliai: 0,
wind_dir: 240,
saulėtekis: '10: 49 ',
ghi: 657.55,
dhi: 106,79,
aqi: 53,
platumas: 40,71,
oras: [objektas],
datos laikas: '2021-09-27: 14',
temperatūra: 22,
stotis: „KJRB“,
aukštis_kampis: 40,89,
app_temp: 21.7
}
],
skaičiuoti: 1
}

Kai kurie svarbesni atsakyme pateiktų duomenų aspektai yra šie:

• Miesto pavadinimas (grąžina miesto pavadinimą pagal nurodytą ilgumą ir platumą).
• Datos laikas (grąžina dabartinę ciklo valandą formatu YYYY-MM-DD: HH).
• Orai (grąžina objektą, kuriame yra orų piktograma, orų kodas ir tekstinis orų aprašymas).

Duomenų paėmimas iš „News REST“ API

Naujienos API Šiame skyriuje naudojamas Newsdata.io. Kaip visi REST API žiniatinklyje pateikiama keletas užklausų parinkčių, kurias galite naudoti norėdami gauti naujienas iš viso pasaulio. Su Newsdata.io API, galite gauti naujienų iš konkrečios šalies arba tam tikra kalba, kategorija ir pan.

Naudodami „JavaScript“ programą galite gauti duomenis iš naujienų REST API. Tiesiog pakeiskite anksčiau pateiktos programos URL šiuo URL:

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

Kitas žingsnis yra pakeisti anksčiau pateiktą URL skyrių „YOUR_API_KEY“ į API raktą, kurį gausite užsiregistravę „Newsdata.io“. Aukščiau pateiktas URL grąžins naujienas iš Amerikos. Tačiau, jei norite naujienų iš Japonijos, galite tiesiog pakeisti užklausą „contry = us“ į „country = jp“.

Norėdami gauti daugiau informacijos apie tai, kaip naudotis Newsdata.io REST API, paspauskite čia.

Susijęs: Norite pridėti naujienų antraštes į savo svetainę ar programą? Jums reikia „Mediastack“ API

Newsdata.io REST API atsako pavyzdys

{
pavadinimas: „Vairuotojas, nužudytas savo automobilio durų, laukdamas eilės greito maisto vairavimo metu, teikdamas atsargias įžvalgas dirbtinio intelekto automobiliams“,
nuoroda: ' 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/',
raktažodžiai: [masyvas],
Kūrėjas: [Masyvas],
video_URL: null,
aprašymas: „Liūdna naujiena apie vairuotoją, kurį nužudė jo paties automobilio durys (važiuojant važiuojant), pateikia įspėjamųjų įžvalgų apie
PG pagrįstų savarankiškai vairuojančių automobilių atsiradimas. Štai viešai neatskleista išvaizda “,
turinys: „Liūdna naujiena apie vairuotoją, kurį nužudė jo paties automobilio durys (važiuojant važiuojant), pateikia įspėjamųjų įžvalgų apie
atsiradęs dirbtiniu intelektu pagrįstas savaeigis automobilis. Štai viešai neatskleista išvaizda “,
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: 'forbes'
}

„Python“ programos naudojimas norint paimti duomenis iš skirtingų poilsio API

Galite paimti savo svetainės ar programos duomenis naudodami bet kurią jums žinomą programavimo kalbą. Taigi, jei nenorite naudoti „JavaScript“, tuos pačius rezultatus galite pasiekti naudodami „Python“ programą.

Susijęs: Kaip sukurti API „Python“: populiarios sistemos

Viskas, ką jums reikia padaryti, tai įdiegti užklausų HTTP python modulį naudojant „pip“ aplinką. Tada galite sukurti „Python“ programą naudodami šį kodą:

# importuokite užklausų biblioteką
importo užklausų
# duomenų paėmimas naudojant užklausų biblioteką
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = mes '
res = request.get (URL)
json = res.json ()
įveskite json:
spausdinti (raktas, json [raktas])

Panašiai kaip ir ankstesniuose pavyzdžiuose, turėsite įterpti savo API atitinkamame skyriuje. Tada gausite tuos pačius duomenis, kuriuos grąžina „JavaScript“ programa.

Gauti savo svetainės ar programos duomenis yra gana paprasta

Dabar turite įrankius, kurių reikia norint surinkti programinės įrangos duomenų duomenis. Svarbu prisiminti, kad POILSIS architektūra palengvina laisvą sujungimą, o tai reiškia, kad galite naudoti bet kurią programavimo kalbą, norėdami paimti duomenis iš bet kurios REST API internete.

Dabar jūs žinote, kaip naudotis Poilsio API, kodėl gi nepabandžius?

Žiniatinklio nuskaitymas vs. API: koks yra geriausias būdas išgauti duomenis?

Duomenų yra visur, tačiau jų paėmimas į rankas yra kita problema - jei tai netgi teisėta.

Skaityti toliau

Apie autorių