Vad är REST API och hur kan du samla in data för din app eller webbplats?

Förkortningen API står för applikationsprogrammeringsgränssnitt. Ett API är en uppsättning funktioner som underlättar kommunikation mellan två program. I huvudsak en API tar en förfrågan från en programvara till en annan och återgår sedan till initieringsprogramvaran med ett relevant svar.

RESTEN betyder representativ tillståndsöverföring, och det är en arkitektur som används för att designa klient-server-applikationer. Med en Rest APIfår du en representation av den begärda informationen som lagras i en databas. A REST API är också statslös, vilket innebär att servern inte lagrar data mellan förfrågningar från klienter.

Om du letar efter en Rest API exempel och en fördjupad förklaring av hur det fungerar, fortsätt läsa.

Hur fungerar ett REST API?

A REST API får åtkomst till data via enhetliga resursidentifierare (URI), som är en teckensträng som identifierar en specifik resurs. Den typ av URI som används av a REST API är en enhetlig resurssökare (URL).

För att komma åt och manipulera resurser, en REST API använder följande begäran verb:

• Get (detta används för att hämta data från en databas)
• Post (lägg till ny data i en databas)
• Put (uppdatera data i en databas)
• Radera (radera data från en databas)

Om du vill använda tjänsterna till en av de många REST API: er tillgänglig på webben (i stället för att bygga en från början) har du bara tillgång till verbet för att få begäran om REST API (via en URL). Dessa webbadresser har flera komponenter, men de som du behöver veta är API nyckel och frågan.

De API key är en unik identifierare som du får när du registrerar dig på a 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 ville få det aktuella vädret i New York City, kan frågesektionen i din webbadress vara "stad = New York".

Exekvering av en get -begäran returnerar ett svar, som innehåller en statuskod och en kropp. Om begäran lyckas kommer ditt svarsteam att innehålla data som du vill använda på din webbplats eller applikation.

Använda en JavaScript -applikation för att fånga data från olika vila -API: er

För att bygga denna enkla applikation finns det två andra program som du måste installera på din dator: NodeJS och npm. Vi har skrivit en artikel om hur man installerar NodeJS och npm på Ubuntu, samt en på hur man gör detta i Windows- så kolla in dem om du vill lära dig mer.

När programmen ovan har installerats på din dator måste du vidta följande steg:

1. Öppna din IDE och starta terminalen.
2. Navigera till mappen som innehåller din JavaScript -applikationsfil med cd -kommandot.
3. Initiera npm med följande kodrad:

npm init -y

Det finns en npm -modul som kommer att spela en nyckelroll i programmets funktionalitet. Detta är modulen got, som är ett HTTP -förfrågningsbibliotek för NodeJS. Följande kodrad installerar den senaste versionen av det hämtade biblioteket i dina applikationsfiler:

npm install fick@senaste

Nu kan du fortsätta och bygga din applikation.

Använda Got -biblioteket för att bygga din applikation

// importera det hämtade biblioteket till din applikation
const got = require ('got');
// hämta data från ett specifikt REST API och skriver ut dess kropp till terminalen
(async () => {
Prova {
const response = vänta fick (URL);
const data = JSON.parse (response.body);
console.log (data);
} catch (fel) {
console.log (error.data);
}
})();

Applikationen ovan kommer att fånga data från alla REST API på webben. Du måste dock ange URL: en för den relevanta resursen först.

Ta tag i data från ett Weather REST API

The Weatherbit.io API är ett av de mer populära vädret REST API: er. Infoga URL: en till detta API i den enkla JavaScript -applikationen ovan kommer appen att fungera.

Använda Weatherbit.io REST API

// importera det hämtade biblioteket till din applikation
const got = require ('got');
// hämta data från ett specifikt REST API och skriver ut dess kropp till terminalen
(async () => {
Prova {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
const response = vänta fick (URL);
const data = JSON.parse (response.body);
console.log (data);
} catch (fel) {
console.log (error.data);
}
})();

Webbadressen för Weatherbit.io API har nu infogats i programmet. Det finns dock en aspekt av webbadressen som du måste justera för att få programmet att köras. Detta är avsnittet märkt "API_KEY", och den här nyckeln är vad du får från Weatherbit.io när du registrerar dig för ett gratis konto.

Du har också möjlighet att justera frågesektionen i koden ovan. Applikationen frågar för närvarande om vädret på latitud 40.7128 och longitud -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 stadsnamnet.

För mer information om hur du använder Weatherbit.io REST API, Klicka här.

Efter att du har lagt in din API nyckel i det relevanta avsnittet ovan kan du nu köra din JavaScript -fil. Programmet kommer att leverera något som liknar följande utdata i din terminal.

Weatherbit.io REST API -svarsexempel

data: [
{
rh: 53,
pod: 'd',
lon: -74.01,
pres: 1005,9,
tidszon: 'America/New_York',
ob_time: '2021-09-27 14:50',
country_code: 'US',
moln: 25,
ts: 1632754200,
solar_rad: 652,8,
state_code: 'NY',
city_name: 'New York City',
wind_spd: 5.66,
wind_cdir_full: 'väst-sydväst',
wind_cdir: 'WSW',
slp: 1015,9,
vis: 5,
h_angle: -30,
solnedgång: '22: 44 ',
dni: 851,72,
dagg: 12,
snö: 0,
UV: 5.68859,
nederbörd: 0,
wind_dir: 240,
soluppgång: '10: 49 ',
ghi: 657,55,
dhi: 106,79,
aqi: 53,
lat: 40.71,
väder: [Objekt],
datetime: '2021-09-27: 14',
temp: 22,
station: 'KJRB',
elev_angle: 40,89,
app_temp: 21.7
}
],
räkna: 1
}

Några av de viktigare aspekterna av data som returneras i svaret inkluderar:

• Stadens namn (returnerar stadens namn på angiven longitud och latitud).
• Datum Tid (returnerar aktuell cykeltimme i formatet ÅÅÅÅ-MM-DD: HH).
• Väder (returnerar 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 används i detta avsnitt är Newsdata.io. Som alla REST API: er på webben ger den flera frågealternativ som du kan använda för att hämta 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 -programmet kan du hämta data från nyheterna REST API. Ersätt helt enkelt webbadressen i programmet 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 när du registrerar dig hos Newsdata.io. Webbadressen ovan kommer att returnera nyheter från Amerika. Men om du vill ha nyheter från Japan kan du helt enkelt ersätta "contry = oss" -frågan med "country = jp".

För mer information om hur du använder Newsdata.io REST API, Klicka här.

Relaterad: Vill du lägga till nyhetsrubriker till din webbplats eller app? Du behöver Mediastack API

Newsdata.io REST API -svarsexempel

{
titel: 'Föraren dödades av sin egen bildörr medan han väntade i kön vid snabbmatskörning, med försiktighetsåtgärder för AI-självkörande bilar',
länk: ' 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/',
nyckelord: [Array],
skapare: [Array],
video_URL: null,
beskrivning: "Trist nyhetsberättelse om en förare som dödades av sin egen bildörr (under körning), ger försiktighetsåtgärder om
tillkomsten av AI-baserade självkörande bilar. Här är insiderlooken. ",
innehåll: "Trist nyhetsberättelse om en förare som dödades av sin egen bildörr (under körning), ger försiktighetsåtgärder om
tillkomsten av AI-baserade självkörande bilar. Här är insiderlooken. ",
pubDatum: '2021-09-27 15:30:00',
bild 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 ett Python -program för att fånga data från olika vila -API: er

Det är möjligt att samla in data för din webbplats eller applikation med ett programmeringsspråk som du känner till. Så om du inte vill använda JavaScript kan du uppnå samma resultat med en Python -applikation.

Relaterad: Hur man bygger API: er i Python: Populära ramverk

Allt du behöver göra är att installera HTTP -pythonmodulen för förfrågningar med pipmiljön. Sedan kan du bygga din Python -applikation med följande kod:

# importera förfrågningsbiblioteket
importförfrågningar
# ta tag i data med hjälp av förfrågningsbiblioteket
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = oss '
res = requests.get (URL)
json = res.json ()
för nyckel i json:
print (key, json [key])

Liksom de tidigare exemplen måste du infoga din API nyckel i det relevanta avsnittet. Du får sedan samma data som JavaScript -programmet returnerar.

Att ta tag i data för din webbplats eller applikation är ganska enkelt

Du har nu de verktyg du behöver för att fånga 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 fånga data från alla REST API på webben.

Nu vet du hur du använder Rest API, varför inte prova?

Webbskrapning vs. API: Vad är det bästa sättet att extrahera data?

Det finns data överallt, men att få tag på det är en annan fråga - om det ens är lagligt.

Läs Nästa

Om författaren