Hvad er REST API, og hvordan kan du indsamle data til din app eller dit websted?

Akronymet API står for applikationsprogrammeringsinterface. An API er et sæt funktioner, der letter kommunikationen mellem to softwareapplikationer. I det væsentlige er en API tager en anmodning fra en softwareapplikation til en anden og vender derefter tilbage til initieringssoftwaren med et relevant svar.

HVILE betyder repræsentativ tilstandsoverførsel, og det er en arkitektur, der bruges til at designe klient-server-applikationer. Med en Rest APIfår du en gengivelse af de ønskede data gemt i en database. EN REST API er også statsløs, hvilket betyder, at serveren ikke gemmer data mellem anmodninger fra klienter.

Hvis du leder efter en Rest API eksempel og en dybdegående forklaring på, hvordan det fungerer, fortsæt med at læse.

Hvordan fungerer en REST API?

EN REST API får adgang til data gennem ensartede ressourceidentifikatorer (URI'er), som er en række tegn, der identificerer en bestemt ressource. Den type URI, der bruges af en REST API er en ensartet ressourcefinder (URL).

For at få adgang til og manipulere ressourcer, en REST API bruger følgende anmodningsverber:

• Get (dette bruges til at hente data fra en database)
• Post (tilføj nye data til en database)
• Put (opdater dataene i en database)
• Slet (slet data fra en database)

Hvis du vil udnytte tjenesterne fra en af ​​de mange REST API'er tilgængelig på internettet (i stedet for at bygge en fra bunden), har du kun adgang til verbet om anmodning om at få REST API (via en URL). Disse webadresser har flere komponenter, men dem du skal vide er API nøgle og forespørgsel.

Det API key er en unik identifikator, som du modtager, når du har registreret dig på a REST API platform. Forespørgslen er normalt en simpel ligning, der bruges til at tilpasse din søgning. Derfor, hvis du ønskede at få det aktuelle vejr i New York City, kan forespørgselsafsnittet i din webadresse være "city = New York".

Udførelse af en get -anmodning returnerer et svar, som indeholder en statuskode og et brødtekst. Hvis anmodningen er vellykket, vil dit svarorgan indeholde de data, du vil bruge på dit websted eller din applikation.

Brug af en JavaScript -applikation til at hente data fra forskellige hvile -API'er

For at bygge denne simple applikation er der to andre softwareprogrammer, du skal installere på din computer: NodeJS og npm. Vi har skrevet en artikel om, hvordan du installerer NodeJS og npm på Ubuntu, samt en på hvordan man gør dette på Windows- så tjek dem ud, hvis du vil lære mere.

Når ovenstående applikationer er installeret på din computer, skal du tage følgende trin:

1. Åbn din IDE og start terminalen.
2. Naviger til mappen, der indeholder din JavaScript -applikationsfil ved hjælp af cd -kommandoen.
3. Initialiser npm med følgende kodelinje:

npm init -y

Der er et npm -modul, der spiller en nøglerolle i denne applikations funktionalitet. Dette er det got -modul, som er et HTTP -forespørgselsbibliotek til NodeJS. Følgende kodelinje installerer den nyeste version af det hentede bibliotek i dine applikationsfiler:

npm installation fik@seneste

Nu kan du gå videre og opbygge din applikation.

Brug af Got -biblioteket til at bygge din applikation

// importer det hentede bibliotek til din applikation
const got = require ('got');
// hent data fra en bestemt REST API og udskriver dens brødtekst til terminalen
(async () => {
prøve {
const respons = afvente fik (URL);
const data = JSON.parse (response.body);
console.log (data);
} fang (fejl) {
console.log (fejl.data);
}
})();

Ansøgningen ovenfor vil fange data fra enhver REST API på nettet. Du skal dog først angive webadressen til den relevante ressource.

Grib data fra en Weather REST API

Weatherbit.io API er et af de mere populære vejr REST API'er. Indsætter URL'en til dette API i den enkle JavaScript -applikation ovenfor vil gøre appen operationel.

Brug af Weatherbit.io REST API

// importer det hentede bibliotek til din applikation
const got = require ('got');
// hent data fra en bestemt REST API og udskriver dens brødtekst til terminalen
(async () => {
prøve {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
const respons = afvente fik (URL);
const data = JSON.parse (response.body);
console.log (data);
} fang (fejl) {
console.log (fejl.data);
}
})();

Webadressen til Weatherbit.io API indsættes nu med succes i applikationen. Der er dog et aspekt af webadressen, som du skal justere for at få programmet til at køre. Dette er afsnittet mærket "API_KEY", og denne nøgle er, hvad du vil modtage fra Weatherbit.io, når du tilmelder dig en gratis konto.

Du har også mulighed for at justere forespørgselsafsnittet i koden ovenfor. Applikationen spørger i øjeblikket om vejret på bredden 40,7128 og længden på -74,0060, men du kan indsætte nye koordinater. Selvom forespørgslen ovenfor er den anbefalede tilgang, kan du søge efter vejret på et sted ved hjælp af bynavnet.

For mere information om, hvordan du bruger Weatherbit.io REST API, Klik her.

Efter at have indsat din API nøgle i det relevante afsnit ovenfor, kan du nu eksekvere din JavaScript -fil. Applikationen leverer noget, der ligner følgende output i din terminal.

Weatherbit.io REST API -svareksempel

data: [
{
rh: 53,
pod: 'd',
lon: -74.01,
pres: 1005,9,
tidszone: '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-sydvest',
wind_cdir: 'WSW',
slp: 1015,9,
vis: 5,
h_angle: -30,
solnedgang: '22: 44 ',
dni: 851,72,
dug: 12,
sne: 0,
uv: 5.68859,
nedbør: 0,
wind_dir: 240,
solopgang: '10: 49 ',
ghi: 657,55,
dhi: 106,79,
aqi: 53,
lat: 40.71,
vejr: [Objekt],
datetime: '2021-09-27: 14',
temp: 22,
station: 'KJRB',
elev_angle: 40,89,
app_temp: 21.7
}
],
tælle: 1
}

Nogle af de mere vigtige aspekter af de data, der returneres i svaret, omfatter:

• Bynavn (returnerer byens navn på den angivne længde- og breddegrad).
• Dato tid (returnerer den aktuelle cyklustime i formatet ÅÅÅÅ-MM-DD: HH).
• Vejr (returnerer et objekt, der indeholder et vejrikon, vejrkode og en tekstbeskrivelse af vejret).

Grib data fra en News REST API

Nyhederne API brugt i dette afsnit er Newsdata.io. Som alle REST API'er på internettet giver det flere forespørgselsmuligheder, som du kan bruge til at hente nyheder fra hele verden. Med Newsdata.io API, kan du få nyheder fra et bestemt land eller på et bestemt sprog, kategori og så videre.

Ved hjælp af JavaScript -applikationen kan du hente data fra nyhederne REST API. Du skal blot erstatte webadressen i ovenstående applikation med følgende URL:

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

Det næste trin er at erstatte afsnittet "YOUR_API_KEY" i URL'en ovenfor med API nøgle, som du modtager, når du har registreret dig hos Newsdata.io. URL'en ovenfor vil returnere nyheder fra Amerika. Men hvis du vil have nyheder fra Japan, kan du blot erstatte forespørgslen "contry = us" med "country = jp".

For mere information om, hvordan du bruger Newsdata.io REST API, Klik her.

Relaterede: Vil du tilføje nyhedsoverskrifter til dit websted eller din app? Du har brug for Mediastack API

Newsdata.io REST API -svareksempel

{
titel: 'Chauffør dræbt af sin egen bildør, mens han ventede i kø ved fastfood-gennemkørsel og gav forsigtighedsindsigt til selvkørende biler i AI',
link: ' 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øgeord: [Array],
skaber: [Array],
video_URL: null,
beskrivelse: "Trist nyhedshistorie om en chauffør, der blev dræbt af sin egen bildør (mens han var i en gennemkørsel), giver advarselsindsigt om
fremkomsten af ​​AI-baserede selvkørende biler. Her er insiderlooket. ",
indhold: "Trist nyhedshistorie om en chauffør, der blev dræbt af sin egen bildør (mens han var i en gennemkørsel), giver advarselsindsigt om
fremkomsten af ​​AI-baserede selvkørende biler. Her er insiderlooket. ",
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'
}

Brug af en Python -applikation til at hente data fra forskellige hvile -API'er

Det er muligt at få fat i data til dit websted eller din applikation ved hjælp af ethvert programmeringssprog, du kender. Så hvis du ikke vil bruge JavaScript, kan du opnå de samme resultater med en Python -applikation.

Relaterede: Sådan opbygges API'er i Python: Populære rammer

Alt du skal gøre er at installere HTTP -python -modulets forespørgsler ved hjælp af pipmiljøet. Derefter kan du opbygge dit Python -program ved hjælp af følgende kode:

# importer anmodningsbiblioteket
importanmodninger
# griber data ved hjælp af forespørgselsbiblioteket
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = os '
res = requests.get (URL)
json = res.json ()
for nøgle i json:
print (nøgle, json [key])

I lighed med de tidligere eksempler skal du indsætte din API nøgle i det relevante afsnit. Du modtager derefter de samme data, som JavaScript -applikationen returnerer.

Det er ret enkelt at få fat i data til dit websted eller din applikation

Du har nu de værktøjer, du har brug for til at få fat i data til dine softwareapplikationer. Det er vigtigt at huske, at HVILE arkitektur letter løs kobling, hvilket betyder, at du kan bruge ethvert programmeringssprog til at hente data fra enhver REST API på nettet.

Nu ved du, hvordan du bruger Rest API, hvorfor ikke prøve det?

Webskrabning vs. API: Hvad er den bedste måde at udtrække data på?

Der er data overalt, men at få fingre i det er et andet problem - hvis det overhovedet er lovligt.

Læs Næste

Om forfatteren