Puede utilizar Java™ API
for RESTful Web Services (JAX-RS) para desarrollar servicios que sigan los principios REST
(Representational State Transfer). Gracias a JAX-RS, se simplifica el desarrollo de servicios
RESTful.
Acerca de esta tarea
Las
posibilidades de JAX-RS se proporcionan mediante el uso de un
servlet o un filtro. Cuando se configura el archivo web.xml de la aplicación web y se ensambla la implementación de IBM® JAX-RS que se basa en la infraestructura
Apache Wink en el directorio de bibliotecas de la aplicación web, la aplicación empresarial estará lista para utilizar las prestaciones JAX-RS.
Para implementar aplicaciones web JAX-RS, siga estos pasos:
Procedimiento
- Configure el entorno de desarrollo.
- Antes de comenzar a desarrollar aplicaciones de JAX-RS, debe configurar su entorno de desarrollo añadiendo las bibliotecas
JAX-RS en la vía de acceso de clases.
- Defina los recursos en aplicaciones web JAX-RS.
- Los recursos son el bloque de compilación básico de creación de un servicio RESTful. Los recursos pueden contener datos actualizados de forma estática o dinámica. Ejemplos de recursos de una aplicación de almacén de libros en línea incluyen un libro, un pedido en una tienda y una colección de usuarios. Identificando los recursos en la aplicación, puede hacer que el servicio resulte más útil y más fácil de desarrollar.
- Configure la aplicación JAX-RS.
Puede configurar aplicaciones JAX-RS de varias maneras en función de sus necesidades.
Para sacar partido de la funcionalidad de Java Platform,
Enterprise Edition (Java EE)
6, puede utilizar las prestaciones de exploración de anotaciones.
Mediante la utilización de la exploración de anotación, puede omitir una subclase
javax.ws.rs.core.Application de JAX-RS o tener una subclase javax.ws.rs.core.Application
mínimamente definida. Como alternativa, puede especificar el servlet o filtro IBM JAX-RS si desea utilizar la funcionalidad disponible en el servlet y filtro IBM JAX-RS.
Si utiliza uno de los métodos de configuración de JAX-RS
Versión 1.1, puede omitir una subclase javax.ws.rs.core.Application en la
aplicación o disponer de una subclase javax.ws.rs.core.Application que devuelva
un conjunto vacío de clases para informar al entorno de ejecución JAX-RS para
que busque y utilice todas las clases JAX-RS de la aplicación. Es recomendable utilizar este método si no desea tener que añadir manualmente cada clase JAX-RS relevante a una subclase javax.ws.rs.core.Application mientras desarrolla la aplicación.
Al especificar el servlet y filtro IBM JAX-RS específicos, puede sacar partido y asegurarse del comportamiento específico de IBM JAX-RS. Por ejemplo, el uso del filtro IBM JAX-RS puede ser útil para el desarrollo de una aplicación web con una mezcla de recursos JAX-RS y archivos JSP (JavaServer Pages) con los mismos patrones de URL.
Aunque existe un método de configuración de JAX-RS V1.1 que soporta el
uso de un archivo web.xml opcional, si desea especificar roles o restricciones
de seguridad o desea aprovechar otras características habilitadas
utilizando un archivo web.xml, debe especificar la información en un archivo web.xml.
Elija uno de los tres métodos siguientes para configurar la aplicación JAX-RS:
- Configurar las aplicaciones JAX-RS
con métodos de JAX-RS 1.1
Utilice este método si desea
utilizar las prestaciones de exploración de anotaciones o utilizar los métodos de configuración de
JAX-RS 1.1. Puede utilizar las prestaciones de
exploración de anotaciones para promover la portabilidad de las aplicaciones, minimizar la cantidad de código
de configuración o modificar dinámicamente la aplicación sin cambios en el código de aplicación.
- Configure el archivo web.xml para los servlets de JAX-RS
Utilice este método si desea especificar características que se habilitan utilizando parámetros de inicialización de servlet para cambiar el comportamiento y asegurarse de obtener el servlet IBM JAX-RS. Cuando se utilizan servlets, puede definir una vía de acceso del servlet en el archivo web.xml que se añadirá al URL base.
- Configure el archivo web.xml para los filtros de JAX-RS
Utilice este método si desea utilizar el filtro cuando tiene los JSP, otros servlets y filtros y recursos
JAX-RS con una combinación de patrones de URL. Puede configurar el archivo web.xml para definir filtros que indiquen los URL posibles
en los que se puede invocar el filtro.
- Ensamble las aplicaciones web JAX-RS.
- Después de desarrollar los archivos de clase Java para la aplicación web de JAX-RS y tras editar el archivo web.xml para habilitar el servlet de JAX-RS, ya estará listo para ensamblar la aplicación. Ensamble la aplicación web en un paquete WAR (archivador web).
Puede ensamblar el paquete WAR en un paquete archivador empresarial (EAR), si fuera preciso.
- Despliegue las aplicaciones web JAX-RS.
- Tras ensamblar la aplicación web de JAX-RS, tendrá que desplegar el paquete archivador web
(WAR) o el paquete archivador empresarial (EAR) en el servidor de aplicaciones.
Resultados
Ha desarrollado y desplegado una aplicación web JAX-RS protegida en el servidor de aplicaciones.