Akronymet API står for applikasjonsprogrammeringsgrensesnitt. An API er et sett med funksjoner som forenkler kommunikasjon mellom to programmer. I hovedsak en API tar en forespørsel fra ett program til et annet, og går deretter tilbake til startprogramvaren med et relevant svar.
HVILE betyr representasjonstilstandsoverføring, og det er en arkitektur som brukes til å designe klient-server-applikasjoner. Med en Rest APIfår du en representasjon av de forespurte dataene som er lagret i en database. EN REST API er også statsløs, noe som betyr at serveren ikke lagrer data mellom forespørsler fra klienter.
Hvis du leter etter en Rest API eksempel og en grundig forklaring på hvordan det fungerer, fortsett å lese.
Hvordan fungerer et REST API?
EN REST API får tilgang til data gjennom uniforme ressursidentifikatorer (URI), som er en streng med tegn som identifiserer en bestemt ressurs. Type URI som brukes av a REST API er en enhetlig ressursfinner (URL).
For å få tilgang til og manipulere ressurser, en REST API bruker følgende forespørselsverb:
- Get (dette brukes til å hente data fra en database)
- Legg ut (legg til nye data i en database)
- Put (oppdater dataene i en database)
- Slett (slett data fra en database)
Hvis du vil bruke tjenestene til en av de mange REST APIer tilgjengelig på nettet (i stedet for å bygge en fra bunnen av), har du bare tilgang til verbet om forespørsel om REST API (gjennom en URL). Disse nettadressene har flere komponenter, men de du trenger å vite er API nøkkelen og spørringen.
De API nøkkelen er en unik identifikator, som du får når du registrerer deg på en REST API plattform. Søket er vanligvis en enkel ligning som brukes til å tilpasse søket ditt. Derfor, hvis du ønsket å få det nåværende været i New York City, kan spørringsdelen i nettadressen din være "city = New York".
Utførelse av en get -forespørsel returnerer et svar, som inneholder en statuskode og et brødtekst. Hvis forespørselen lykkes, vil svarorganet inneholde dataene du vil bruke på nettstedet eller applikasjonen din.
Bruke en JavaScript -applikasjon for å hente data fra forskjellige hvile -APIer
For å bygge denne enkle applikasjonen er det to andre programmer du må installere på datamaskinen din: NodeJS og npm. Vi har skrevet en artikkel om hvordan du installerer NodeJS og npm på Ubuntu, samt en på hvordan du gjør dette på Windows- så sjekk dem hvis du vil lære mer.
Etter at programmene ovenfor er installert på datamaskinen din, må du gjøre følgende:
- Åpne IDE og start terminalen.
- Naviger til mappen som inneholder JavaScript -applikasjonsfilen din ved hjelp av cd -kommandoen.
- Initialiser npm med følgende kodelinje:
npm init -y
Det er en npm -modul som vil spille en nøkkelrolle i denne applikasjonens funksjonalitet. Dette er modulen got, som er et HTTP -forespørselsbibliotek for NodeJS. Følgende kodelinje vil installere den nyeste versjonen av det hentede biblioteket i applikasjonsfilene dine:
npm install fikk@siste
Nå kan du fortsette og bygge søknaden din.
Bruke Got -biblioteket til å bygge applikasjonen din
// importer det hentede biblioteket til applikasjonen din
const got = require ('got');
// hente data fra et bestemt REST API og skriver ut kroppen til terminalen
(async () => {
prøv {
const respons = venter på fikk (URL);
const data = JSON.parse (response.body);
console.log (data);
} fang (feil) {
console.log (error.data);
}
})();
Søknaden ovenfor vil hente data fra alle REST API på internett. Du må imidlertid oppgi nettadressen til den relevante ressursen først.
Henter data fra et Weather REST API
The Weatherbit.io API er et av de mer populære været REST APIer. Setter inn URL -en til denne API i den enkle JavaScript -applikasjonen ovenfor vil gjøre appen operativ.
Bruke Weatherbit.io REST API
// importer det hentede biblioteket til applikasjonen din
const got = require ('got');
// hente data fra et bestemt REST API og skriver ut kroppen til terminalen
(async () => {
prøv {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
const respons = venter på fikk (URL);
const data = JSON.parse (response.body);
console.log (data);
} fang (feil) {
console.log (error.data);
}
})();
Nettadressen til Weatherbit.io API er nå satt inn i programmet. Imidlertid er det ett aspekt av nettadressen du må justere for å få programmet i gang. Dette er delen merket "API_KEY", og denne nøkkelen er det du vil motta fra Weatherbit.io når du registrerer deg for en gratis konto.
Du har også muligheten til å justere spørringsdelen i koden ovenfor. Søknaden spør for øyeblikket om været på breddegraden 40.7128 og lengden på -74.0060, men du kan sette inn nye koordinater. Selv om spørringen ovenfor er den anbefalte tilnærmingen, kan du søke etter været på et sted ved å bruke bynavnet.
For mer informasjon om hvordan du bruker Weatherbit.io REST API, Klikk her.
Etter å ha satt inn din API nøkkelen i den relevante delen ovenfor, kan du nå utføre JavaScript -filen. Programmet vil levere noe som ligner på følgende utgang i terminalen din.
Weatherbit.io REST API -responseksempel
data: [
{
rh: 53,
pod: 'd',
lon: -74.01,
pres: 1005,9,
tidssone: 'America/New_York',
ob_time: '2021-09-27 14:50',
country_code: 'US',
skyer: 25,
ts: 1632754200,
solar_rad: 652.8,
state_code: 'NY',
city_name: 'New York City',
wind_spd: 5.66,
wind_cdir_full: 'vest-sørvest',
wind_cdir: 'WSW',
slp: 1015,9,
vis: 5,
h_angle: -30,
solnedgang: '22: 44 ',
dni: 851,72,
dugg: 12,
snø: 0,
UV: 5.68859,
nedbør: 0,
wind_dir: 240,
soloppgang: '10: 49 ',
ghi: 657,55,
dhi: 106,79,
aqi: 53,
lat: 40.71,
vær: [Objekt],
datetime: '2021-09-27: 14',
temperatur: 22,
stasjon: 'KJRB',
elev_angle: 40,89,
app_temp: 21.7
}
],
telle: 1
}
Noen av de viktigere aspektene ved dataene som returneres i svaret inkluderer:
- By Navn (returnerer navnet på byen på angitt lengdegrad og breddegrad).
- Dato tid (returnerer gjeldende syklustime i formatet ÅÅÅÅ-MM-DD: HH).
- Vær (returnerer et objekt som inneholder et værikon, værkode og en tekstbeskrivelse av været).
Henter data fra et News REST API
Nyhetene API brukt i denne delen er Newsdata.io. Som alle REST APIer på nettet gir den flere spørringsalternativer som du kan bruke til å hente nyheter fra hele verden. Med Newsdata.io API, kan du få nyheter fra et bestemt land, eller på et bestemt språk, kategori og så videre.
Ved å bruke JavaScript -applikasjonen kan du hente data fra nyhetene REST API. Bare erstatt nettadressen i programmet ovenfor med følgende URL:
' https://newsdata.io/api/1/news? apikey = YOUR_API_KEY & country = us '
Det neste trinnet er å erstatte "YOUR_API_KEY" -delen i nettadressen ovenfor med API nøkkel du mottar etter at du har registrert deg hos Newsdata.io. URL -adressen ovenfor vil returnere siste nytt fra Amerika. Men hvis du vil ha nyheter fra Japan, kan du ganske enkelt erstatte spørringen “contry = us” med “country = jp”.
For mer informasjon om hvordan du bruker Newsdata.io REST API, Klikk her.
I slekt: Vil du legge til nyhetsoverskrifter på nettstedet eller appen din? Du trenger Mediastack API
Newsdata.io REST API -responseksempel
{
tittel: 'Driver drept av sin egen bildør mens han ventet i kø ved Fast-Food Drive-Thru, og ga forsiktighetsinnsikt for selvkjørende biler i AI',
lenke: ' 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/',
søkeord: [Array],
skaperen: [Array],
video_URL: null,
beskrivelse: "Trist nyhetshistorie om en sjåfør som ble drept av sin egen bildør (mens han var gjennomkjørt), gir advarsel om
fremkomsten av AI-baserte selvkjørende biler. Her er insider -utseendet. ",
innhold: "Trist nyhetshistorie om en sjåfør som ble drept av sin egen bildør (mens han var gjennomkjørt), gir forsiktighetsinnsikt om
fremkomsten av AI-baserte selvkjørende biler. Her er insider -utseendet. ",
pubDato: '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'
}
Bruke en Python -applikasjon for å hente data fra forskjellige hvil -APIer
Det er mulig å hente data for nettstedet eller applikasjonen din ved å bruke et hvilket som helst programmeringsspråk du er kjent med. Så hvis du ikke vil bruke JavaScript, kan du oppnå de samme resultatene med en Python -applikasjon.
I slekt: Hvordan bygge APIer i Python: Populære rammer
Alt du trenger å gjøre er å installere forespørslene HTTP python -modul ved hjelp av pip -miljøet. Deretter kan du bygge Python -applikasjonen din ved å bruke følgende kode:
# importer forespørselsbiblioteket
importforespørsler
# ta tak i data ved hjelp av forespørselsbiblioteket
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = oss '
res = requests.get (URL)
json = res.json ()
for nøkkel i json:
print (key, json [key])
I likhet med de tidligere eksemplene må du sette inn din API nøkkelen i den relevante delen. Du vil da motta de samme dataene som JavaScript -programmet returnerer.
Å hente data for nettstedet eller applikasjonen din er ganske enkelt
Du har nå verktøyene du trenger for å hente data for programmer. Det er viktig å huske at HVILE arkitektur letter løs kobling, noe som betyr at du kan bruke hvilket som helst programmeringsspråk for å hente data fra alle REST API på internett.
Nå vet du hvordan du bruker Rest API, hvorfor ikke prøve det?
Det er data overalt, men å få hendene på det er et annet problem - hvis det er lovlig.
Les neste
- Programmering
- API
- Programmering
- Datahøsting
Kadeisha Kean er en fullstabel programvareutvikler og teknisk/teknologisk skribent. Hun har den særegne evnen til å forenkle noen av de mest komplekse teknologiske konseptene; produsere materiale som lett kan forstås av enhver nybegynner i teknologi. Hun brenner for å skrive, utvikle interessant programvare og reise verden rundt (gjennom dokumentarer).
Abonner på vårt nyhetsbrev
Bli med i vårt nyhetsbrev for tekniske tips, anmeldelser, gratis ebøker og eksklusive tilbud!
Klikk her for å abonnere