Wat is REST API en hoe kunt u gegevens voor uw app of website verzamelen?

het acroniem API staat voor Application Programming Interface. Een API is een reeks functies die de communicatie tussen twee softwaretoepassingen vergemakkelijken. in wezen, een API neemt een verzoek van de ene softwaretoepassing naar de andere over en keert vervolgens terug naar de initiërende software met een relevant antwoord.

REST betekent representatieve statusoverdracht en het is een architectuur die wordt gebruikt om client-server-applicaties te ontwerpen. Met een Rest-API, krijgt u een weergave van de gevraagde gegevens die zijn opgeslagen in een database. EEN REST-API is ook stateless, wat betekent dat de server geen gegevens opslaat tussen verzoeken van clients.

Als u op zoek bent naar een Rest-API voorbeeld en een uitgebreide uitleg over hoe het werkt, blijf lezen.

Hoe werkt een REST-API?

EEN REST-API heeft toegang tot gegevens via uniform resource identifiers (URI's), een reeks tekens die een specifieke bron identificeren. Het type URI dat wordt gebruikt door a REST-API is een uniform resource locator (URL).

Om toegang te krijgen tot bronnen en deze te manipuleren, is een REST API gebruikt de volgende verzoekwerkwoorden:

• Get (dit wordt gebruikt om gegevens uit een database te verkrijgen)
• Post (nieuwe gegevens toevoegen aan een database)
• Put (update de gegevens in een database)
• Verwijderen (gegevens verwijderen uit een database)

Als u gebruik wilt maken van de diensten van een van de vele REST API's beschikbaar op het web (in plaats van er een helemaal opnieuw te bouwen), heb je alleen toegang tot het get-verzoekwerkwoord van de REST-API (via een url). Deze URL's hebben verschillende componenten, maar degene die u moet weten, zijn de API sleutel en de vraag.

De API key is een unieke identificatie die u ontvangt zodra u zich registreert op een REST-API platform. De zoekopdracht is meestal een eenvoudige vergelijking die wordt gebruikt om uw zoekopdracht te personaliseren. Daarom, als u het huidige weer in New York City wilt zien, kan het zoekgedeelte van uw URL "city=New York" zijn.

Het uitvoeren van een get-verzoek retourneert een antwoord, dat een statuscode en een hoofdtekst bevat. Als het verzoek succesvol is, bevat uw reactielichaam de gegevens die u op uw website of applicatie wilt gebruiken.

Een JavaScript-toepassing gebruiken om gegevens uit verschillende rest-API's te halen

Om deze eenvoudige toepassing te bouwen, zijn er twee andere softwaretoepassingen die u op uw computer moet installeren: NodeJS en npm. We hebben een artikel geschreven over hoe te installeren NodeJS en npm op Ubuntu, evenals een op hoe dit te doen op Windows- dus bekijk die eens als je meer wilt weten.

Nadat de bovenstaande applicaties op uw computer zijn geïnstalleerd, moet u de volgende stappen uitvoeren:

1. Open uw IDE en start de terminal.
2. Navigeer met de opdracht cd naar de map met uw JavaScript-toepassingsbestand.
3. Initialiseer npm met de volgende regel code:

npm init -y

Er is één npm-module die een sleutelrol zal spelen in de functionaliteit van deze applicatie. Dit is de got-module, een HTTP-verzoekbibliotheek voor NodeJS. De volgende regel code installeert de nieuwste versie van de got-bibliotheek in uw toepassingsbestanden:

npm install got@latest

Nu kunt u doorgaan en uw applicatie bouwen.

De Got-bibliotheek gebruiken om uw toepassing te bouwen

// importeer de gekregen bibliotheek in je applicatie
const got = vereisen ('kreeg');
// haal gegevens op van een specifieke REST API en print de body naar de terminal
(asynchrone () => {
proberen {
const response = wacht op gekregen (URL);
const data = JSON.parse (response.body);
console.log (gegevens);
} vangst (fout) {
console.log (fout.gegevens);
}
})();

De bovenstaande applicatie haalt gegevens van elke REST-API op internet. U moet echter eerst de URL voor de relevante bron opgeven.

Gegevens uit een Weather REST API halen

The Weatherbit.io API is een van de meest populaire weer REST API's. De URL hiervan invoegen API in de eenvoudige JavaScript-toepassing hierboven zal de app operationeel maken.

De Weatherbit.io REST API gebruiken

// importeer de gekregen bibliotheek in je applicatie
const got = vereisen ('kreeg');
// haal gegevens op van een specifieke REST API en print de body naar de terminal
(asynchrone () => {
proberen {
const-URL = ' https://api.weatherbit.io/v2.0/current? lat=40.7128&lon=-74.0060&key=API_KEY';
const response = wacht op gekregen (URL);
const data = JSON.parse (response.body);
console.log (gegevens);
} vangst (fout) {
console.log (fout.gegevens);
}
})();

De URL voor Weatherbit.io API is nu succesvol ingevoegd in de applicatie. Er is echter één aspect van de URL dat u moet aanpassen om de toepassing te laten werken. Dit is het gedeelte met het label "API_KEY", en deze sleutel is wat u ontvangt van Weatherbit.io wanneer u zich registreert voor een gratis account.

U hebt ook de mogelijkheid om de querysectie in de bovenstaande code aan te passen. De applicatie bevraagt ​​momenteel het weer op de breedtegraad van 40.7128 en de lengtegraad van -74.0060, maar u kunt nieuwe coördinaten invoegen. Hoewel de bovenstaande zoekopdracht de aanbevolen benadering is, kunt u op een locatie naar het weer zoeken met behulp van de stadsnaam.

Voor meer informatie over het gebruik van Weatherbit.io REST-API, Klik hier.

Na het plaatsen van uw API toets in de relevante sectie hierboven, kunt u nu uw JavaScript-bestand uitvoeren. De toepassing levert iets dat lijkt op de volgende uitvoer in uw terminal.

Weatherbit.io REST API-reactievoorbeeld

gegevens: [
{
rechts: 53,
pod: 'd',
lengte: -74.01,
druk: 1005.9,
tijdzone: 'Amerika/New_York',
ob_time: '2021-09-27 14:50',
country_code: 'VS',
wolken: 25,
ts: 1632754200,
zonne_rad: 652.8,
state_code: 'NY',
city_name: 'New York City',
wind_spd: 5.66,
wind_cdir_full: 'west-zuidwest',
wind_cdir: 'WSW',
slp: 1015,9,
tegenover: 5,
h_hoek: -30,
zonsondergang: '22:44',
dni: 851.72,
dauwpunt: 12,
sneeuw: 0,
uv: 5.68859,
neerslag: 0,
wind_dir: 240,
zonsopgang: '10:49',
ghi: 657.55,
dhi: 106,79,
aqi: 53,
breedte: 40.71,
weer: [Object],
datumtijd: '2021-09-27:14',
temperatuur: 22,
zender: 'KJRB',
hoogtehoek: 40.89,
app_temp: 21.7
}
],
aantal: 1
}

Enkele van de belangrijkste aspecten van de gegevens die in het antwoord worden geretourneerd, zijn:

• Stads naam (geeft de naam van de stad terug op de opgegeven lengte- en breedtegraad).
• Datum Tijd (geeft het huidige cyclusuur terug in de indeling JJJJ-MM-DD: HH).
• Het weer (retourneert een object met een weerpictogram, weercode en een tekstbeschrijving van het weer).

Gegevens uit een News REST API halen

Het nieuws API gebruikt in deze sectie is Newsdata.io. Zoals alles REST API's op het web biedt het verschillende zoekopties die u kunt gebruiken om het laatste nieuws van over de hele wereld op te halen. Met de Newsdata.io API, kunt u nieuws krijgen uit een specifiek land, of in een bepaalde taal, categorie, enzovoort.

Met behulp van de JavaScript-toepassing kunt u gegevens uit het nieuws halen REST-API. Vervang eenvoudig de URL in de bovenstaande applicatie door de volgende URL:

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

De volgende stap is om het gedeelte 'YOUR_API_KEY' in de bovenstaande URL te vervangen door de API sleutel die u ontvangt nadat u zich heeft geregistreerd bij Newsdata.io. De bovenstaande URL zal het laatste nieuws uit Amerika retourneren. Als u echter nieuws uit Japan wilt, kunt u eenvoudig de "contry=us"-query vervangen door "country=jp".

Voor meer informatie over het gebruik van Newsdata.io REST-API, Klik hier.

Verwant: Wilt u nieuwskoppen toevoegen aan uw website of app? U hebt Mediastack-API nodig

Newsdata.io REST API-reactievoorbeeld

{
titel: 'Bestuurder gedood door zijn eigen autodeur terwijl hij in de rij stond te wachten bij fastfood-drive-thru, wat waarschuwende inzichten biedt voor zelfrijdende AI-auto's',
koppeling: ' 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/',
trefwoorden: [Array],
maker: [Array],
video_URL: null,
beschrijving: "Triest nieuwsbericht over een bestuurder die werd gedood door zijn eigen autodeur (tijdens een drive-thru), geeft waarschuwende inzichten over
de komst van op AI gebaseerde zelfrijdende auto's. Hier is de insider-look.",
inhoud: "Triest nieuwsbericht over een bestuurder die werd gedood door zijn eigen autodeur (tijdens een drive-thru), geeft waarschuwende inzichten over de
komst van op AI gebaseerde zelfrijdende auto's. Hier is de insider-look.",
pubDatum: '2021-09-27 15:30:00',
afbeelding 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'
}

Een Python-toepassing gebruiken om gegevens uit verschillende rust-API's te halen

Het is mogelijk om gegevens voor uw website of applicatie te verzamelen met behulp van elke programmeertaal die u kent. Dus als u geen JavaScript wilt gebruiken, kunt u dezelfde resultaten bereiken met een Python-toepassing.

Verwant: Hoe API's in Python te bouwen: populaire frameworks

Het enige dat u hoeft te doen, is de HTTP-python-module voor verzoeken installeren met behulp van de pip-omgeving. Vervolgens kunt u uw Python-toepassing bouwen met behulp van de volgende code:

# importeer de verzoekenbibliotheek
importverzoeken
# gegevens ophalen met behulp van de verzoekenbibliotheek
URL = ' https://newsdata.io/api/1/sources? apikey=YOUR_API_KEY=ons'
res = verzoeken.get (URL)
json = res.json()
voor sleutel in json:
print (sleutel, json[sleutel])

Net als bij de vorige voorbeelden, moet u uw API toets in het betreffende gedeelte. U ontvangt dan dezelfde gegevens die de JavaScript-toepassing retourneert.

Gegevens ophalen voor uw website of applicatie is vrij eenvoudig

U beschikt nu over de tools die u nodig hebt om gegevens voor uw softwaretoepassingen te verzamelen. Het is belangrijk om te onthouden dat de REST architectuur maakt losse koppeling mogelijk, wat betekent dat u elke programmeertaal kunt gebruiken om gegevens van elke REST-API op internet.

Nu weet je hoe je het moet gebruiken Rest-API, waarom niet eens proberen?

Webscraping vs. API: wat is de beste manier om gegevens te extraheren?

Er zijn overal gegevens, maar het is een ander probleem om het in handen te krijgen, als het al legaal is.

Lees volgende

Over de auteur