Förkortningen API står för applikationsprogrammeringsgränssnitt. En API är en uppsättning funktioner som underlättar kommunikation mellan två mjukvaruapplikationer. I huvudsak en API tar en förfrågan från en mjukvaruapplikation till en annan och återgår sedan till den initierande programvaran med ett relevant svar.
RESTEN betyder representativ tillståndsöverföring, och det är en arkitektur som används för att designa klient-serverapplikationer. Med en Rest API, får du en representation av den begärda informationen lagrad i en databas. A REST API är också tillståndslös, vilket innebär att servern inte lagrar någon data mellan förfrågningar från klienter.
Om du letar efter en Rest API exempel och en djupgående förklaring av hur det fungerar, fortsätt läsa.
Hur fungerar ett REST API?
A REST API åtkomst till data genom enhetliga resursidentifierare (URI), som är en teckensträng som identifierar en specifik resurs. Typen av URI som används av en REST API är en enhetlig resurslokaliserare (URL).
För att komma åt och manipulera resurser, en REST API använder följande förfrågningsverb:
Hämta (detta används för att hämta data från en databas) Lägg upp (lägg till ny data till en databas) Lägg (uppdatera data i en databas) Ta bort (ta bort data från en databas)
Om du vill utnyttja tjänsterna från en av de många REST API:er tillgängligt på webben (istället för att bygga en från början) har du bara tillgång till få begäran verbet för REST API (via en URL). Dessa webbadresser har flera komponenter, men de som du behöver känna till är API nyckeln och frågan.
De API nyckel är en unik identifierare som du får när du registrerar dig på en REST API plattform. Frågan är vanligtvis en enkel ekvation som används för att anpassa din sökning. Därför, om du vill få det aktuella vädret i New York City, kan frågedelen av din webbadress vara “stad=New York”.
Genom att köra en get-begäran returneras ett svar som innehåller en statuskod och en text. Om begäran lyckas kommer din svarsdel att innehålla de uppgifter du vill använda på din webbplats eller applikation.
Använda en JavaScript-applikation för att hämta data från olika vilo-API:er
För att bygga denna enkla applikation finns det två andra program som du behöver installera på din dator: NodeJS och npm. Vi har skrivit en artikel om hur man installerar NodeJS och npm på Ubuntu, samt en om hur man gör detta på Windows – så kolla in dem om du vill lära dig mer.
När programmen ovan har installerats på din dator måste du ta följande steg:
- Öppna din IDE och starta terminalen. Navigera till mappen som innehåller din JavaScript-programfil med kommandot cd. Initiera npm med följande kodrad:
npm init -y
Det finns en npm-modul som kommer att spela en nyckelroll i denna applikations funktionalitet. Detta är got-modulen, som är ett HTTP-förfrågningsbibliotek för NodeJS. Följande kodrad kommer att installera den senaste versionen av got-biblioteket i dina programfiler:
npm install [email protected]
Nu kan du gå vidare och bygga din ansökan.
Använda Got Library för att bygga din applikation
//import the got library into your application
const got = require('got');//fetch data from a specific REST API and prints its body to the terminal
(async () => {
try {const response = await got(URL);
const data = JSON.parse(response.body);
console.log(data);
} catch (error) {
console.log(error.data);
}
})();
Appen ovan kommer att ta data från alla REST API på webben. Du måste dock ange webbadressen för den relevanta resursen först.
Ta data från ett Weather REST API
The Weatherbit.io API är ett av de mer populära vädret REST API:er. Infogar webbadressen till detta API i den enkla JavaScript-applikationen ovan kommer appen att fungera.
Använder Weatherbit.io REST API
//import the got library into your application
const got = require('got');//fetch data from a specific REST API and prints its body to the terminal
(async () => {
try {
const URL = 'https://api.weatherbit.io/v2.0/current?lat=40.7128&lon=-74.0060&key=API_KEY';
const response = await got(URL);
const data = JSON.parse(response.body);
console.log(data);
} catch (error) {
console.log(error.data);
}
})();
Webbadressen till Weatherbit.io API har nu infogats i applikationen. Det finns dock en aspekt av webbadressen som du måste justera för att få programmet att köra. Det här är avsnittet märkt “API_KEY”, och den här nyckeln är vad du kommer att få från Weatherbit.io när du registrerar dig för en free konto.
Du har också möjlighet att justera frågeavsnittet i koden ovan. Applikationen frågar för närvarande vädret på latituden 40,7128 och longituden -74,0060, men du kan infoga nya koordinater. Även om frågan ovan är den rekommenderade metoden, kan du söka efter vädret på en plats med hjälp av stadens namn.
För mer information om hur du använder Weatherbit.io REST API, Klicka här.
Efter att du har satt in din API knappa in det relevanta avsnittet ovan kan du nu köra din JavaScript-fil. Applikationen kommer att leverera något som liknar följande utgång i din terminal.
Weatherbit.io REST API svarsexempel
data: [
{
rh: 53,
pod: 'd',
lon: -74.01,
pres: 1005.9,
timezone: 'America/New_York',
ob_time: '2021-09-27 14:50',
country_code: 'US',
clouds: 25,
ts: 1632754200,
solar_rad: 652.8,
state_code: 'NY',
city_name: 'New York City',
wind_spd: 5.66,
wind_cdir_full: 'west-southwest',
wind_cdir: 'WSW',
slp: 1015.9,
vis: 5,
h_angle: -30,
sunset: '22:44',
dni: 851.72,
dewpt: 12,
snow: 0,
uv: 5.68859,
precip: 0,
wind_dir: 240,
sunrise: '10:49',
ghi: 657.55,
dhi: 106.79,
aqi: 53,
lat: 40.71,
weather: [Object],
datetime: '2021-09-27:14',
temp: 22,
station: 'KJRB',
elev_angle: 40.89,
app_temp: 21.7
}
],
count: 1
}
Några av de viktigare aspekterna av data som returneras i svaret inkluderar:
Stadens namn (returnerar namnet på staden vid angivna longitud och latitud). Datum Tid (returerar den aktuella cykeltimmen i formatet ÅÅÅÅ-MM-DD: HH). Väder (returerar ett objekt som innehåller en väderikon, väderkod och en textbeskrivning av vädret).
Ta tag i data från ett News REST API
Nyheterna API som används i detta avsnitt är Newsdata.io. Som alla REST API:er på webben erbjuder den flera frågealternativ, som du kan använda för att hämta senaste nyheter från hela världen. Med Newsdata.io API, kan du få nyheter från ett specifikt land, eller på ett visst språk, kategori och så vidare.
Med hjälp av JavaScript-applikationen kan du hämta data från nyheterna REST API. Byt bara ut URL:en i applikationen ovan med följande URL:
'https://newsdata.io/api/1/news?apikey=YOUR_API_KEY&country=us'
Nästa steg är att ersätta avsnittet “YOUR_API_KEY” i webbadressen ovan med API nyckel som du får efter att du registrerat dig hos Newsdata.io. Webbadressen ovan kommer att returnera de senaste nyheterna från Amerika. Men om du vill ha nyheter från Japan kan du helt enkelt ersätta “contry=us”-frågan med “country=jp”.
För mer information om hur du använder Newsdata.io REST API, Klicka här.
Newsdata.io REST API Response Exempel
{
title: 'Driver Killed By His Own Car Door While Waiting In Line At Fast-Food Drive-Thru, Providing Cautionary Insights For AI Self-Driving Cars',
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/',
keywords: [Array],
creator: [Array],
video_URL: null,
description: "Sad news story about a driver that was killed by his own car door (while in a drive-thru), provides cautionary insights about
the advent of AI-based self-driving cars. Here's the insider look.",
content: "Sad news story about a driver that was killed by his own car door (while in a drive-thru), provides cautionary insights about the
advent of AI-based self-driving cars. Here's the insider look.",
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'
}
Använda en Python-applikation för att hämta data från olika vilo-API:er
Det är möjligt att hämta data för din webbplats eller applikation med vilket programmeringsspråk som helst som du är bekant med. Så om du inte vill använda JavaScript kan du uppnå samma resultat med en Python-applikation.
Allt du behöver göra är att installera requests HTTP python-modulen med hjälp av pip-miljön. Sedan kan du bygga din Python-applikation med följande kod:
# import the requests library
import requests
# grabbing data using the requests library
URL = 'https://newsdata.io/api/1/sources?apikey=YOUR_API_KEY=us'
res = requests.get(URL)
json = res.json()
for key in json:
print(key, json[key])
I likhet med de tidigare exemplen måste du infoga din API knappa in det relevanta avsnittet. Du får då samma data som JavaScript-applikationen returnerar.
Det är ganska enkelt att hämta data för din webbplats eller applikation
Du har nu verktygen du behöver för att hämta data för dina program. Det är viktigt att komma ihåg att RESTEN arkitektur underlättar lös koppling, vilket innebär att du kan använda vilket programmeringsspråk som helst för att hämta data från alla REST API på webben.
Nu vet du hur du använder Rest API, varför inte ge det ett försök?
Om författaren
Kadeisha Kean (39 artiklar publicerade)
Kadeisha Kean är en full-stack mjukvaruutvecklare och teknisk/teknikskribent. Hon har den distinkta förmågan att förenkla några av de mest komplexa tekniska koncepten; producera material som lätt kan förstås av alla nybörjare. Hon brinner för att skriva, utveckla intressant programvara och att resa runt i världen (genom dokumentärer).
Mer från Kadeisha Kean
Prenumerera på vårt nyhetsbrev
Gå med i vårt nyhetsbrev för tekniska tips, recensioner, free e-böcker och exklusiva erbjudanden!
Klicka här för att prenumerera
