Buenas prácticas para el desarrollo de servicios web REST

Comparto con mis compañeros de clase algunas pautas recomendadas a tomar en cuenta que investigué:

Nombres de recursos sensibles

Se debe tener nombre idóneos para los recursos como ejemplo,  /boletas/225 en lugar de /api?type= boletas &id=225) esto nos permite tener mayor comprensión de lo que una solicitud determinada hace. Para nombrar los recursos no es adecuado utilizar los parámetros de URL del querystring (esto es idóneo para el filtrado).

Utilizar nombres apropiados para denominar los recursos permite mayor comprensión de la API de servicios. Los recursos se ven jerárquicamente a través de sus nombres URI, los cuales ofrecen a los consumidores fácil comprensión de la jerarquía de los recursos para aprovechar en sus aplicaciones.

Evitar usar verbos en la denominación de los recursos y usar sustantivos permite una mayor claridad.

rest

Usar verbos HTTP (CRUD)

Para obtener y modificar los recursos se utiliza los verbos POST, GET, PUT y DELETE que pueden ser utilizados por cualquier consumidor API. Esto nos permite tener mayor claridad y comprensión de lo que una solicitud determinada hace. Las peticiones GET no deben cambiar los datos subyacentes de los recursos.

 

Crear recursos expresos

Al principio, es mucho más fácil crear las API que imitan el dominio de aplicación subyacente o la arquitectura de base de datos del sistema. A través del tiempo, se requerirá  servicios-servicios agregados que usen múltiples recursos subyacentes para reducir chattiness. Es mucho más fácil crear mayores recursos después de los recursos individuales de lo que es la creación de recursos de grano fino o individuo de agregados más grandes. Hacer más fácil para usted y comenzar con los recursos pequeños, fáciles de definir, proporcionando funcionalidad CRUD en ellos.

xml

XML y JSON

Lo ideal es dejar que los consumidores cambien de una a otra simplemente cambiando la extensión de. Xml a Json. Además, para soportar las interfaces de usuario de estilo AJAX, una respuesta envuelto es muy útil. Brindar una respuesta envuelto, ya sea por defecto o por extensiones separadas, tales como. Wjson y. Wxml para indicar que el cliente solicita un JSON o XML respuesta envueltos.

 

Considerar la conectividad

La conectividad es uno de los principios de REST por los enlaces hipermedios y el uso de hipervínculos. Mientras que los servicios siguen siendo útiles y sin ellos, APIs a ser más auto-descriptivo cuando los enlaces se devuelven en la respuesta.

Referencias:

https://eamodeorubio.wordpress.com/2010/07/26/servicios-web-2-%C2%BFque-es-rest/

http://www.forosdelweb.com/f18/aporte-entendiendo-las-cabeceras-post-get-put-delete-920883/

http://www.dosideas.com/noticias/java/314-introduccion-a-los-servicios-web-restful.html

JSON vs XML: Cómo JSON es Superior a XML

 

Anuncios

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s