Wie REST Arbeitet

Allgemeines sprechend, bezieht empfängt ein REST-Antrag, mit ein einen Antrag zu einem speziellen URL zu schicken (ähnlich zu, was Sie sehen würden, nachdem Sie aus einer Form mit der ERHALTENMETHODE gefüllt hatten) und dann ein XML Dokument, welches die Antwort des Bedieners enthält. Die XML Antwort wird dann analysiert, und die gewünschten Informationen werden auf extrahiert und fungiert.

Jeder REST-Antrag hat im Allgemeinen einige allgemeine Elemente:

• Endpunkt URL — die volle Adresse für den gewünschten Index. Ein REST-Service konnte nur einen einzelnen Index haben, der alle Antragarten anfaßt, oder unterschiedliche Indexe für unterschiedlichen Antrag schreibt.

• Entwickler Identifikation — erfordern die meisten REST-Dienstleistungen irgendeine Art des Entwicklers Identifikation oder befestigen, mit jedem Antrag gesendet zu werden. Dieses kennzeichnet den Ursprung des Antrags und wird im Allgemeinen zu aufspürenzwecken verwendet. Etwas Dienstleistungen können diesen Wert verwenden, um die Zahl den Fragen zu begrenzen, die während eines gegebenen Zeitrahmens laufen gelassen werden.

• Gewünschte Tätigkeit — wenige Bediener haben einen einzigartigen Endpunkt für alle möglichen Anträge. Als solcher, wird es im Allgemeinen angefordert, um die gewünschte Tätigkeit im Antrag einzuschließen.

• Parameter, die — einige Parameter mit dem Antrag eingeschlossen werden müssen, die erbetene Tätigkeit mit irgendeinem Kontext zu versehen (zum Beispiel, konnte die gewünschte Tätigkeit eine Suche sein; die Parameter konnten eine Art und die Schlüsselwortwerte des Buches und der Art sein).

Mit jenen Elementen im Verstand, können Sie einen theoretischen Antrag verursachen:

Hier wird ein Antrag zum Endpunkt http://library.example.com/api.php, mit einem Entwicklerschlüssel von 123 geschickt. Die gewünschte Tätigkeit ist Suche, und Art und Schlüsselwortparameter sind mit Werten des Buches und der Art eingeschlossen. Diesen Antrag gegeben, würde die Antwort etwas so schauen:

<?xml version="1.0" kodierend = "UTF-8"? >
< LibraryAPI xmlns="http://library.example.com/api/spec" >
< Antrag >
< RequestId>123a456</RequestId >
< Parameter >
< Argument Name="devkey" Value="123"/>
< Argument Name="action" Wert = "Such"/>
< Argument Name="type" Wert = "Buch"/>

< Argument Name="keyword" Wert = "Art"/>
</Parameter >
</Antrag >
< Antwort >
< ResultCount>2</ResultCount >
< Einzelteil >
< Title>Style Buch Vol. 1</Title >
< Status>Out</Status >
< Holds>3</Holds >
< CopiesOnHand>2</CopiesOnHand >
< Author>Jon Doe</Author >
</Einzelteil >
< Einzelteil >
< Title>Style Buch Vol. 2</Title >
< Status>In</Status >
< Holds>0</Holds >
< CopiesOnHand>1</CopiesOnHand >
< Author>Jon Doe</Author >
</Einzelteil >
</Antwort >
</LibraryAPI >

Sie können sehen, daß die Antwort einige strukturelle Elemente hat. Zuerst erklärt sich sie, um XML 1.0 zu sein und verwendet UTF-8 für die Kodierung. Das LibraryAPI Element ist das Wurzelelement dieses Dokumentes und schließt die spezifizierten namespaces ein. Zweitens der Antragabschnitt; er ist allgemein, damit REST-Anträge alle Informationen einschließen, die mit dem Antrag in der Antwort gesendet werden. Dieses addiert Klarheit und kann die Programmierung am Ende des Bittstellers erleichtern. Hier sehen Sie jedes der vier Elemente, die zum Service geführt werden.

Schließlich ein genaueres wenig schauend, beachten Sie, daß in diesem Fall die Antwort irgendein metadata über die Resultate zurückgebracht hat, gezeigt im ResultCount Umbau, zusammen mit den Resultat Einzelteilen selbst. Für diesen Antrag sehen Sie, daß jedes Buch innerhalb eines Einzelteilelements eingekapselt wird, das fünf Kinder hat, die spezifische Attribute der Bücher beschreiben.