Generalmente parlando, una richiesta di RESTO coinvolgerà trasmettere una richiesta ad un URL speciale (simile a che cosa vedreste dopo avere ampliato una forma usando il metodo di OTTEN), allora ricevente un documento di XML che contiene la risposta dell'assistente. La risposta di XML allora è analizzata e le informazioni volute sono estratte e si comportano su.
|
|
Ogni richiesta di RESTO ha generalmente parecchi elementi comuni:
URL di punto finale — l'indirizzo completo per lo scritto voluto. Un servizio di RESTO potrebbe avere soltanto un singolo scritto che maneggia tutti i tipi di richiesta, o gli scritti differenti per la richiesta differente scrive.
Dei servizi di RESTO — di identificazione dello sviluppatore la maggior parte richiedono una certa specie dell'identificazione dello sviluppatore o chiudono a chiave per essere trasmessi con ogni richiesta. Ciò identifica l'origine della richiesta e generalmente è usata per gli scopi d'inseguimento. Alcuni servizi possono usare questo valore per limitare il numero di domande fatte funzionare durante la data struttura di tempo.
L'azione voluta — pochi assistenti ha un punto finale unico per tutte le richieste possibili. Come tali, è richiesto generalmente per includere l'azione voluta nella richiesta.
Parametri che — parecchi parametri dovranno essere inclusi con la richiesta di fornire l'azione chiesta un certo contesto (per esempio, l'azione voluta potrebbe essere una ricerca; i parametri hanno potuto essere un tipo ed i valori di parole chiavi di libro e di stile).
Con quegli elementi in mente, potete generare una richiesta teorica:
Qui una richiesta è trasmessa al punto finale http://library.example.com/api.php, con una chiave dello sviluppatore di 123. L'azione voluta è ricerca ed i parametri di parola chiave e del tipo sono inclusi con i valori del libro e dello stile. Dato quella richiesta, la risposta osserverebbe qualcosa come questa:
<?xml version="1.0" che mette = "UTF-8"? >
< LibraryAPI xmlns="http://library.example.com/api/spec" >
< richiesta >
< RequestId>123a456</RequestId >
< parametri >
< "/> Di Name="devkey "Value="123 Di Discussione
< valore di Name="action di discussione" = "/>" di
ricerca
< valore di Name="type di discussione" = "/>" del libro
< valore di Name="keyword di discussione" = "/>"
di stile
</parametri >
</richiesta >
< risposta >
< ResultCount>2</ResultCount >
< articolo >
< Volume 1</Title Del Libro Di Title>Style >
< Status>Out</Status >
< Holds>3</Holds >
< CopiesOnHand>2</CopiesOnHand >
< Author>Jon Doe</Author >
</articolo >
< articolo >
< Volume 2</Title Del Libro Di Title>Style >
< Status>In</Status >
< Holds>0</Holds >
< CopiesOnHand>1</CopiesOnHand >
< Author>Jon Doe</Author >
</articolo >
</risposta >
</LibraryAPI >
Potete vedere che la risposta ha parecchi elementi strutturali. In primo luogo, si dichiara per essere XML 1.0 ed usa UTF-8 per mettere. L'elemento di LibraryAPI è l'elemento della radice di questo documento ed include i namespaces specificati. In secondo luogo, la sezione di richiesta; è comune affinchè le richieste di RESTO includa tutte le informazioni trasmesse con la richiesta nella risposta. Ciò aggiunge la chiarezza e può facilitare la programmazione sull'estremità del richiedente. Qui vedete ciascuno dei quattro elementi passati al servizio.
Per concludere, osservando un poco più vicino, noterete che in questo caso la risposta ha restituito un certo metadata circa i risultati, indicati nella modifica di ResultCount, con gli articoli essi stessi di risultato. Per questa richiesta vedete che ogni libro è incapsulato all'interno di un elemento dell'articolo, che ha cinque bambini che descrivono gli attributi specifici dei libri.
Online: 530 users browsing the articles directory
|
|