Introducción al diseño de una API HTTP (Parte 2 de 4) : HTTP Responses

Este segundo artículo abarca una breve introducción sobre las respuestas HTTP (HTTP Responses).

¿Qué es un HTTP Response?

Un HTTP Response, es la respuesta que devuelve un servidor web luego de recibir y procesar una solicitud HTTP (HTTP Request) de un cliente. La estructura del mensaje del HTTP Response es similar en formato al HTTP Request. Veamos un ejemplo.

La primera línea se denomina “línea de estado” y contiene dos partes de información. El primero es el protocolo, en este caso HTTP 1.1, seguido de un espacio. La segunda información es el estado de la solicitud (status code), que se compone de una representación numérica del estado (un código de estado) analizable por el emisor, seguida de una nueva línea. En el ejemplo, el código de estado HTTP es 200 OK.

Al igual que un HTTP Request, el HTTP Response contiene una serie de pares de headers (clave: valor). El nombre del header está a la izquierda, seguido de dos puntos y un espacio, y luego el valor, seguido de una nueva línea. Se recomienda que los nombres del header inicien con una letra mayúscula. Los headers pueden repetirse si tienen múltiples valores, por ejemplo, puedes repetir el header Set-Cookie nos permite establecer varias cookies en una sola respuesta.

Los headers son seguidos por un cuerpo (body response) opcional, que requiere dos nuevas líneas de la última cabecera antes del inicio del contenido del cuerpo. Casi todas las respuestas incluirán un cuerpo aunque es técnicamente opcional.

Headers del HTTP Response

Al igual que los headers del HTTP Request, los headers del HTTP Response representan metadatos que envía el servidor al cliente. Por lo general, hacemos uso de un header HTTP estándar, pero a veces es necesario inventar uno propio. Para hacerlo, se sugiere prefijar el nombre del header con X-, como por ejemplo X-Request-ID. La siguiente lista representa los headers más comunes utilizados en un HTTP Response.

Cache-Control: especifica la política del mecanismo de caché. Por ejemplo, si usamos el valor no-cache le estamos diciendo al cliente que no almacene en cache el recurso o colección solicitado.

Content-Language: especifica el idioma del contenido, por ejemplo en-US, lo cual indica que el idioma del contenido del HTTP Response está en ingles.

Content-Length: corresponde al tamaño en bytes del contenido (body) del HTTP Response, si se conoce antes de tiempo.

Content-Type: hace referencia al tipo de contenido del cuerpo, por ejemplo, podemos usar el valor “application/json“, de esta manera le estamos diciendo al cliente que el contenido enviado esta en formato JSON.

Date: Fecha y hora del servidor.

Expires: Fecha y hora en que el contenido debe caducar en el cliente.

Server: utilizado para identificar al servidor.

Hablemos de los códigos de estados HTTP

Los códigos de estado HTTP (ó HTTP Status Code) se separan en diferentes rangos numéricos, cada rango representa una clase diferente de estados. En las siguientes secciones de este artículo describiremos cada rangos así como valores comunes dentro de cada rango.

Códigos de Estado HTTP – Informativos: 1xx

El rango 1XX de los códigos de estado (100 – 199) son códigos informativos de estado. Generalmente, estos códigos de estado son muy poco usados, dependerá si el API que construyas, lo requiere.

101 Switching Protocols: usados para websockets.

Códigos de Estado HTTP – Exitosos: 2xx

El rango 2XX de códigos de estado (200 – 299) son códigos de estado satisfactorios. Señalan al cliente que cualquier operación, tal como crear un recurso o simplemente recuperar uno, se ha completado satisfactoriamente. Generalmente estos códigos de estado son los más consumidos y producidos con mayor frecuencia.

200 OK: significa que el procesamiento y respuesta de servidor fue exitoso.

201 Created: significa que el recurso ha sido creado. Por ejemplo, cuando envías un POST Request puedes esperar este código de estado del servidor.

202 Accepted: significa que el recurso fue creado o modificado con éxito pero el cambio es asíncrono.

204 No Content: significa que la solicitud tuvo éxito pero el HTTP Response no tiene un cuerpo (Response body)

Códigos de Estado HTTP – Redirección: 3XX

El rango 3XX de códigos de estado (300 – 399) se utiliza para redirigir al cliente de un lugar a otro. Los HTTP Response con estos códigos de estado no tienen un cuerpo, sino que hacen uso de un header de ubicación. Contiene una URL a la que se debe redirigir el cliente.

301 Moved Permanently: significa que el recurso esta en una nueva ubicación, sugiere ir a la nueva dirección (URL).

302 Found: significa que el recurso está en la nueva ubicación pero siempre compruebe la antigua ubicación.

Códigos de Estado HTTP – Error del Cliente: 4XX

El rango 4XX de códigos de estado (400 – 499) hace referencia a errores originados por el cliente. Es decir, el servidor encontró un error en la solicitud HTTP del cliente. La operación NO debería haber alterado el estado del servidor. Es importante trabajar con estos códigos de estado en tu API HTTP.

400 Invalid Request: significa que existe un error genérico del cliente.

401 Unauthorized: significa que el cliente debe proporcionar un header de autorización.

403 Forbidden: significa que el cliente no esta autorizado a acceder a dicho recurso.

404 Not Found: significa que el recurso no fue encontrado en el servidor, recurso no existe.

405 Method Not Allowed: significa que el endpoint existe pero no admite el método HTTP de la solicitud.

406 Not Acceptable: significa que el servidor no puede generar una respuesta para el tipo de contenido (content-type) enviado en el header Accept.

Códigos de Estado HTTP – Error del Servidor: 5XX

El rango 5XX de códigos de estado (500 – 599) hace referencia a los errores que se producen en el servidor o tal vez la solicitud no fue recibida. Estos errores deben evitarse a toda costa.

500 Internal Server Error: significa que un error genérico ocurrió en el servidor.

501 Not Implemented: significa que el servidor todavía no admite la combinación de método / endpoint de la solicitud del cliente.

503 Service Unavailable: significa que el servidor no está disponible temporalmente. Por ejemplo, cuando hacemos trabajos de mantenimiento o tenemos la base de datos desconectada.

521 Web Server Is Down: significa que un servidor intermediario no puede conectarse al servidor destino.

Fuentes de referencia:

  1. Status Code HTTP

Para conocer la lista completa de artículos, dirigirse a Introducción al diseño de una API HTTP.

¿Cuándo usar SOAP? ¿Cuándo usar REST?

arquitectura-orientada-a-servicios-soap-rest

¿Cuál es mejor?

SOAP, acrónimo de Simple Object Access Protocol, ha sido por muchos años el enfoque dominante en la Arquitectura Orientada a Servicios (SOA) para muchas organizaciones. Se convirtió en el protocolo predilecto para lograr la interoperabilidad entre aplicaciones. Sin embargo, su expansión se ha visto rezagada por una segunda alternativa de computación distribuida llamada REST (Representational State Transfer) que si bien existe desde que apareció el protocolo HTTP (es decir, por los años 1991), ha tomado mucha relevancia en la última década, siendo usado en casi un 70% de las API’s públicas.

Pero, ¿Cuál es mejor?, ¿Qué protocolo de comunicación debo usar?. Para responderlas, hay que comprender como funciona cada una de ellas y que caracteristicas las diferencia.

¿Por qué SOAP?

SOAP es un protocolo maduro con una especificación completa y compleja, capaz de dar soluciones a casi cualquier necesidad en lo que a comunicaciones se refiere. Ha sido diseñado para exponer operaciones individuales denominados web services. Una de las razones por la que SOAP aún sigue vigente en muchas empresas, es que SOAP brinda un soporte de comunicación de los sistemas legados de una organización.

Otras consideraciones a tener en cuenta son:

SOAP es una buena alternativa para aplicaciones que requieran comunicarse mediante contratos para su API y el consumidor, ya que puede imponer el uso de contratos formales mediante el uso de WSDL (Web Service Description Language).

La seguridad es otro de los puntos fuertes de los servicios SOAP. El WS-RM o Web Service Reliable Messaging describe un protocolo que le permite a SOAP incrementar la seguridad en la ejecución y procesamiento asíncrono de mensajes.

SOAP trabaja las operaciones con estado. SOAP ha sido diseñado para apoyar la gestión del estado en la comunicación.

¿Por qué REST?

REST es un estilo de arquitectura  de software fácil de entender, soportado sobre el protocolo HTTP y sus métodos básicos de mantenimiento, permitiendo que sea fácil codificar y documentar aplicaciones usando servicios REST.

Además, REST hace un uso eficiente del ancho de banda, ya que es mucho más ligero que usar SOAP. A diferencia de SOAP, REST no almacena el estado y las lecturas a sus servicios puede almacenarse en caché para mejorar el rendimiento y escalabilidad.

Es compatible con muchos formatos de datos para intercambiar información pero el formato predominante para los navegadores web es JSON.

REST se centra en operaciones basada en recursos, heredando las operaciones HTTP (GET, PUT, UPDATE, DELETE, POST). Esto hace que muchos programadores de aplicaciones web y navegadores se sientan familiarizado con REST.

La simplicidad que ofrece REST es una de las razones más fuertes para que grandes empresas como Google, Facebook y Amazon estén moviendo sus APIs SOAP a APIs RESTFul.

Es muy usado en aplicaciones que requieran un alto número de mensajes de ida y vuelta, además de aplicaciones que por algún motivo dejan de responder,es ahí donde REST permite activar su proceso de re-intento.

REST permite llamadas fáciles y rápidas mediante una dirección URL.

uso soap y rest

Fuentes y Referencias: