Question

Hola, buenas a usted buena persona.

Próximamente tengo que exponer acerca del tema: Web Service- Rest; y dentro de mi presentación quiero mencionar una de sus características la cuál es: -Maneja mensajes auto-descriptivos.
Esta característica dicta que los mensajes HTTP (post,get,put,delete) deben ser tan descriptivos como sea posible para permitir a los intermediarios(caché,gateway,firewall sino estoy mal) interpretar fácilmente los mensajes y ejecutar servicios en nombre del usuario.
Mi duda es... no tengo en si una idea clara de como sea esto, y no he hallado un ejemplo claro y directo de esta característica para poder entenderla y darla como ejemplo en mi exposición. Me seria de gran ayuda que me proporcionaran un ejemplo de un mensaje auto-descriptivo HTTP donde se puedan señalar sus propiedades.

Saludos y gracias por leer.

Answer 1

Hola @Dr oscar,

a lo que se refiere con lo de "mensajes autodescriptivos" es que los nombres de las llamadas haga referencia a la acción a ejecutar. Por ejemplo para una API REST escrita en PHP que está en el directorio /api del servidor, y tenés una API para obtener una lista de productos, sería autodescriptivo que la llamada sea:

http://servidor.com/api/getProducts.php

y que el código en getProducts.php sea el que devuelve la lista. Dado que el script PHP puede tener un nombre arbitrario, no sería descriptivo que la llamada sea a retagagfaqertq.php y sería directamente confuso que la llamada sea a getTomatoes.php, aunque el código dentro del script sea el mismo y devuelva una correcta lista de productos.

Otra cosa importante al diseñar la interfaz de una API es que sea coherente: si para pedir algo la llamada tiene la forma getThing-to-do.php, que todas tengan la misma forma, en este caso, que empiecen con get, que siga el nombre de la acción en inglés y que sea camelcase. Daría lo mismo que la llamada no tenga get: en este caso que ninguna tenga get

Es algo análogo a cuando se pide en un software que las variables sean descriptivas, es decir, que el nombre de la variable de una idea de qué es lo que contiene.

Saludos cordiales!