fcocascales / phpRestQuery

Clases PHP para enviar y recibir REST

Clases PHP para enviar y recibir REST

Introducción

1. El cliente realiza una petición a un servidor.
2. El servidor recibe la petición y manda una respuesta al cliente.
3. El cliente finalmente recibe la respueta del servidor.

Índice

• Clase RestClient
• Clase RestServer
• Clases de la carpeta network
• Clases para datos con formato
• Pruebas
• Enlaces

---

Clase "RestClient"

Envía una petición al servidor y recibe su respuesta

1) Constructor

Método	Descripción
__construct(Format)	Establece el formato. Instancia ClientRequest y ClientResponse

2) Construye la petición

Método	Descripción
setServer	Dirección URL del servidor
setUri	Parámetros por URI "/uno/dos/..."
setQuery setQueryString	Parámetros por GET "?name=value&..."
setMethod	Método: GET, POST, PUT, DELETE, ...
setMime	Tipo de formato en el mensaje
setContent setData	Contenido del mensaje

3) Envío la petición

Método	Descripción
send():ClientResponse	Envía la petición al servidor

4) Obtiene la respuesta

Método	Descripción
getCode	El código HTTP: 200, 404, ...
getMime	El tipo MIME de la respuesta
getContent getData	El mensaje de respuesta

Clases hijas

• RestClientJSON
• RestClientXML

---

Clase "RestServer"

Recibe la petición del cliente y da una respuesta

1) Constructor

Método	Descripción
__construct	Instancia ServerRequest y ServerResponse

2) Recibe la petición

Método	Descripción
getRequest	Clase ServerRequest
getUri	Datos por URI "/uno/dos/..."
getQuery getQueryString	Datos por GET "?name=value&..."
getMime	Tipo MIME del mensaje
getMethod	Método: GET, POST, PUT, DELETE, ...
getContent getData	Contenido del mensaje

3) Construye la respuesta

Método	Descripción
setResponse	Clase ServerResponse
setCode	Código HTTP: 200, 404, ...
setMime	Formato del mensaje
setContent setData	Establece el mensaje de respuesta

4) Envía la respuesta

Método	Descripción
send	Respuesta al cliente

---

Clases de la carpeta network

De uso general

Clase	Descripción
Constants	Constantes de METHODS, MIMES y CODES
Header	Tratamiento de las líneas de una cabecera HTTP
URL	Normaliza una dirección URL

Petición del cliente al servidor

Clase	Descripción
Request	Clase base que almacena los datos de una petición
ClientRequest	Agrega el método getURL a la clase Request
ServerRequest	Recupera la petición a partir de $_SERVER y php://input

Respuesta del servidor al cliente

Clase	Descripción
Response	Clase base que almacena los datos de una respuesta
ClientResponse	Hereda de Response
ServerResponse	Hereda de Response

---

Clases para datos con formato JSON, XML, etc.

Clase "format/Data"

Almacena datos en el formato especificado

Método1	Método2	Descripción
getFormat	setFormat	Formato de datos con la clase Format
getData	setData	Datos en crudo almacenados en array
getText	setText	Datos string codificados según el formato
encode	decode	Implementación de la clase Format

Clase abstracta "format/Format"

Método	Descripción
mime():string	Retorna el tipo MIME
header	Escribe el encabezado de respuesta
encode(array):string	Codifica al formato
decode(string):array	Decodifica el formato

Clases hijas (mime):

• FormatJSON — application/json
• FormatXML — application/xml
• FormatURL — application/x-www-form-urlencoded
• FormatText — text/plain
• FormatHTML — text/html
• FormatYAML — text/x-yaml

---

Pruebas

Con formulario

• form/sender echo
• form/sender Google geocode

Tests

• rest/network/test_URL
• rest/network/test_URI
• rest/network/test_Header
• rest/network/test_ServerRequest
• rest/network/test_Server
• rest/network/test_Client
• rest/format/test_Data
• rest/test_JSON
• rest/test_RestServer
• rest/test_RestClient

---

Enlaces

• Creating a RESTful API with PHP — Corey Maynard
• Accessing Incoming PUT Data from PHP — LORNAJANE blog
• Servicios web (2): ¿Qué es REST? —
• API REST: qué es y cuáles son sus ventajas en el desarrollo de proyectos —

Qué es una REST API

• REST API concepts and examples — YouTube
• Using REST APIs in a web application — YouTube