Generalmente hablando, una petición del RESTO implicará el enviar de una petición a un URL especial (similar a lo que usted vería después de llenar una forma usando el método del CONSEGUIR), entonces recibiendo un documento de XML que contiene la respuesta del servidor. La respuesta de XML entonces se analiza, y la información deseada se extrae y se actúa sobre.
|
|
Cada petición del RESTO tiene generalmente varios elementos comunes:
URL de la punto final — la dirección completa para la escritura deseada. Un servicio del RESTO pudo tener solamente una sola escritura que maneja todos los tipos de la petición, o diversas escrituras para diversa petición mecanografían.
De los servicios del RESTO — de la identificación del revelador la mayoría requieren una cierta clase de identificación del revelador o la afinan para ser enviada con cada petición. Esto identifica el origen de la petición y se utiliza generalmente para los propósitos que siguen. Algunos servicios pueden utilizar este valor para limitar el número de las preguntas funcionadas durante un marco de tiempo dado.
La acción deseada — pocos servidores tiene una punto final única para todas las peticiones posibles. Como tal, se requiere generalmente para incluir la acción deseada en la petición.
Parámetros que — varios parámetros necesitarán ser incluidos con la petición de proveer de la acción solicitada un cierto contexto (por ejemplo, la acción deseada pudo ser una búsqueda; los parámetros pudieron ser un tipo, y los valores de las palabras claves del libro y del estilo).
Con esos elementos en mente, usted puede crear una petición teórica:
Aquí una petición se envía a la punto final http://library.example.com/api.php, con una llave del revelador de 123. La acción deseada es búsqueda, y el tipo y los parámetros con palabra clave se incluyen con valores del libro y del estilo. Dado esa petición, la respuesta miraría algo como esto:
<?xml version="1.0" que codifica = "UTF-8"? >
< LibraryAPI xmlns="http://library.example.com/api/spec" >
< petición >
< RequestId>123a456</RequestId >
< parámetros >
< "/> De Name="devkey "Value="123 De la Discusión
< valor de Name="action de la discusión" = ""/> de la
búsqueda
< valor de Name="type de la discusión" = ""/> del
libro
< valor de Name="keyword de la discusión" = ""/>
del estilo
</parámetros >
</petición >
< respuesta >
< ResultCount>2</ResultCount >
< artículo >
< Libro Vol. 1</Title De Title>Style >
< Status>Out</Status >
< Holds>3</Holds >
< CopiesOnHand>2</CopiesOnHand >
< Author>Jon Doe</Author >
</artículo >
< artículo >
< Libro Vol. 2</Title De Title>Style >
< Status>In</Status >
< Holds>0</Holds >
< CopiesOnHand>1</CopiesOnHand >
< Author>Jon Doe</Author >
</artículo >
</respuesta >
</LibraryAPI >
Usted puede ver que la respuesta tiene varios elementos estructurales. Primero, se declara para ser XML 1.0 y utiliza UTF-8 para codificar. El elemento de LibraryAPI es el elemento de la raíz de este documento e incluye los namespaces especificados. En segundo lugar, la sección de la petición; es común para que las peticiones del RESTO incluyan toda la información enviada con la petición en la respuesta. Esto agrega claridad, y puede facilitar la programación en el extremo del solicitante. Aquí usted ve cada uno de los cuatro elementos pasados al servicio.
Finalmente, mirando un pedacito más cercano, usted notará que en este caso la respuesta ha vuelto algún metadata sobre los resultados, demostrados en la etiqueta de ResultCount, junto con los artículos ellos mismos del resultado. Para esta petición usted ve que cada libro está encapsulado dentro de un elemento del artículo, que tiene cinco niños que describan las cualidades específicas de los libros.
Online: 543 users browsing the articles directory
|
|