Hoe REST Works

In het algemeen, een REST verzoek omvat het verzenden van een verzoek om een speciale URL (vergelijkbaar met wat je zou zien na het invullen van een formulier met behulp van de GET-methode), dan het ontvangen van een XML-document met daarin het antwoord van de server. De XML-antwoord wordt vervolgens ontleed, en de gewenste informatie wordt geëxtraheerd en opgevolgd.

Elke REST verzoek in het algemeen heeft een aantal gemeenschappelijke elementen:

• Eindpunt URL - Het volledige adres voor de gewenste script. Een REST dienst zou kunnen hebben slechts een script dat alle soorten vragen, of verschillende scripts voor verschillende soorten verzoek afhandelt.

• Ontwikkelaar ID - De meeste REST diensten vereisen een vorm van developer-ID of toets worden verzonden met elk verzoek. Dit geeft de oorsprong van het verzoek en wordt meestal gebruikt voor het bijhouden doeleinden. Sommige diensten kunnen gebruik maken van deze waarde tot beperking van het aantal zoekopdrachten uit te voeren gedurende een bepaald tijdsbestek.

• Gewenste actie - Weinig servers hebben een unieke eindpunt voor alle mogelijke vragen. Als zodanig is het in het algemeen verplicht om de gewenste actie in het verzoek.

• Parameters - Verscheidene parameters moeten worden opgenomen met het verzoek om de gevraagde actie met enkele context (bijvoorbeeld voorzien, kan de gewenste actie worden een zoekopdracht; de parameters kan een type zijn, en de waarden van het boek van trefwoorden en stijl).

Met die elementen in het achterhoofd, kunt u een theoretische verzoek:

Hier is een aanvraag wordt gestuurd naar het eindpunt http://library.example.com/api.php, met een ontwikkelaar sleutel van 123. De gewenste actie is zoeken, en het type en zoekwoord parameters worden opgenomen met de waarden van het boek en stijl. Gezien het feit dat verzoek, zou het antwoord iets als volgt uitzien:

123a456

2


Uit
3
2
Jon Doe



In
0
1
Jon Doe

U kunt zien dat de respons heeft een aantal structurele elementen. Ten eerste, verklaart zij zich te XML 1.0 en maakt gebruik van UTF-8 voor codering. De LibraryAPI element is het root element van dit document en bevat de opgegeven namespaces. Ten tweede, het verzoek deel; het gebruikelijk is voor REST verzoeken om alle informatie zijn verstuurd met het verzoek in de respons. Dit voegt helderheid, en kan programmeren gemak op einde van de opvrager. Hier zie je elk van de vier elementen doorgegeven aan de dienst.

Ten slotte, zoek een beetje dichterbij, zult u merken dat in dit geval het antwoord is teruggekeerd sommige metadata over de resultaten, weergegeven in de ResultCount tag, samen met het resultaat objecten zelf. Voor dit verzoek zie je elk boek is ingekapseld in een post-element, die vijf kinderen die beschrijven specifieke attributen van de boeken heeft.