Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web

Servicios Web y Arquitecturas REST

Manual de creacin y uso de un Web Service REST

REQUERIMIENTOS PREVIOS
Se requiere instalar el IDE NetBeans 8.0.2, para lo cual se debe ir
al sitio web https://netbeans.org/ y descargar el paquete Java EE
o el paquete All, ya que son los que incluyen el servidor web de
aplicaciones GlassFish, JEE (para usar jsp), y HTML, todos ellos
necesarios el uso de webservices.
De no contar con JDK (Java Development Kit), debe ser instalado
previo a la instalacin de NetBeans, ya que es el que provee las he- Pantalla 1. Inicializacin de NetBeans
rramientas de desarrollo para ste IDE. JDK se puede descargar
desde www.oracle.com donde tambin hay disponible una versin de NetBeans que incluye JDK.

1. CREACIN DE UN SERVICIO WEB

1.1.
Creacin del nuevo proyecto
Una vez abierto NetBeans se
debe crear un nuevo proyecto el
cual contendr el sitio web de la
aplicacin y el servicio web.
Para ello se debe dirigir al men
superior y dar clic en File,
posteriormente dar clic en New
Project lo cual abrir un cuadro de dilogo.
Ya que lo que se pretende es
realizar un servicio web, al crear
Pantalla 2. Creacin de un nuevo proyecto
el proyecto, en el primer paso
(Eleccin del proyecto) se debe
elegir la categora Java Web y del lado derecho, en
tipos de proyectos seleccionar Web Application. Una
vez hecho esto es necesario dar clic en el botn [Next]
para continuar con el proceso.
Este manual ser guiado usando como ejemplo un muy
pequeo sistema que manipule datos de alumnos titulados. As pues, para el segundo paso de la creacin del
proyecto, se deben escribir el nombre que se le designar al proyecto, en este caso ser TitulacionAlum- Pantalla 3. Eleccin de tipo de proyecto a crear
nos. Opcionalmente se puede definir otra ubicacin
01 de febrero de 2015

Pgina 1 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

para guardar el proyecto usando el botn [Browse], teniendo en cuenta el cambio de ruta no afectar al proyecto.
As mismo, al crear el servicio web se producirn dependencias de libreras, y en caso de que se desee ubicarlas en
una carpeta en especfico habr que activar e indicar la ubicacin para almacenarlas. Una vez definidos los parmetros
deber darse clic en el botn [Next >].
El tercer paso se debe definir el servidor sobre el
que se ejecutar el servicio web as como la versin de Java Pantalla 4. Nombrar y establecer ubicacin
del proyecto
EE que se desee usar para el desarrollo. Si se emplea la ltima versin de NetBeans se pueden emplear los valores
por defecto, es decir, servidor web GlasFish Server 4.1
y la plataforma Java EE 7 Web y dar clic en el botn
[Next >].
En el cuarto y ltimo paso se debe indicar si se
desea emplear un framework para el desarrollo del proyecto, pero ya que este manual aborda un ejemplo bsico,
no es necesario hacer la seleccin de ninguno de ellos, con
lo cual se puede dar clic en el botn [Finish] para que co- Pantalla 5. Configuraciones y servidor
mience la generacin del proyecto, es decir, la estructura
de carpetas y archivos esenciales necesarios del proyecto.
Una vez finalizada la creacin del proyecto, deber aparecer el proyecto recin creado en el panel izquierdo dentro
de la pestaa Projects.

Pantalla 7. Eleccin de frameworks

Pantalla 6. Proyecto correctamente creado

1.2.
Preparar el entorno previo para usar REST
El proyecto recin creado har uso de REST, por lo que previamente
habr que simular un entorno similar a como lo ofrecera un servidor que
provea el servicio web. Para ello ser necesario inicializar los servidores
de aplicaciones y de bases de datos, as como contar con una base de
datos que contenga informacin que pueda ser manipulable. El primer
paso ser ir al panel Services, desplegar el elemento Servers y dar
clic derecho sobre GlassFish para iniciarlo.

01 de febrero de 2015

Pantalla 8. Iniciar GlassFish

Pgina 2 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

Si todo sali bien, en el panel Output deber aparecer la palabra started al final de los
pasos.
Posteriormente se proceder a hacer un
paso similar pero ahora dando clic derecho sobre Pantalla 9. Correcta inicializacin de GlassFish
Java DB y luego en Start Server, el cual es el
servidor de bases de datos incluido en NetBeans.

Pantalla 11. Correcta inicializacin del servidor Apache Derby

Pantalla 10. Iniciar Servidor de BD

Aunque es posible crear una completa base de datos propia, este manual muestra la creacin de una tabla en la base de datos de muestra de
Apache Derby. Para ello es necesario dirigirse al panel Services y seguir
la ruta Databases > jdbc.derby > APP para posteriormente dar clic derecho sobre Tables y seleccionar la opcin Create Table.

Pantalla 12. Creacin de una

tabla en la BD

El cuadro de dilogo recin abierto solicitar un nombre de tabla, as

como agregar los campos que se deseen. Para este ejemplo se han usado
los el nombre de tabla titulacin y los campos id, cuenta, nombre,
temaTesis y fechaTesis, tal como se muestra en la imagen. Si todo sali bien, en el
panel de Services deber aparecer la
nueva tabla que fue nombrada como TITULACIN.

Pantalla 14. Creacin de la tabla de la BD

A continuacin se introducirn manualmente datos a la tabla recin creada con el fin de testearla ms adelante. Para ello es necesario dar
clic derecho sobre la tabla TITULACIN y desde el men contextual
que emerge elegir la opcin View data, lo cual desplegar en el rea
de trabajo la librera jdbc.derby para que puedan manipularse los datos
Pantalla 13. Creacin cotanto con instrucciones de comando como con un asistente.
rrecta de la tabla

01 de febrero de 2015

Pgina 3 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

Para hacerlo ms simple se insertarn nuevos registros desde el

asistente, as que ser dar clic sobre el botn Insert Record(s) que se
encuentra justo debajo de la pestaa select * from.

Pantalla 15. Abrir panel de

visualizacin de datos

Pantalla 16. Botn para insertar nuevos registros

Desde el cuadro de dilogo podrn ingresarse

tantos registros como se desee simplemente dando clic
sobre el botn sobre el botn [Add Row] cada que
quiera agregarse uno.
Si la insercin de los datos fue correcta deberan
mostrarse stos dentro del panel de resultados de las
consultas.
Pantalla 17. Agregar registros a la tabla

Pantalla 18. Visualizacin de datos recin agregados a la tabla de la BD

1.3.
Configurar el proyecto para usar REST
Ya que el proyecto debe conectarse a una base de datos, requerir de libreras para su correcto funcionamiento con Apache Derby. As pues el siguiente paso es modificar el proyecto para agregar las libreras correspondientes, para ello hay que dar cli derecho sobre el proyecto y seleccionar la
ltima de las opciones
llamada Properties, lo
cual abrir una ventana
en donde se ha de ubicar
en el apartado Libraries, despus dar clic
sobre el botn [Add
JAR/Folder].
Pantalla 19. Editar propiedades del proyecto
Pantalla 20. Propiedades del proyecto

01 de febrero de 2015

Pgina 4 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

Es necesario agregar las libreras derby.jar y derbyclient.jar, ambas ubicadas en la ruta

de instalacin de GlassFish y que comnmente es C:\Program Files\GlassFish-4.1\jabadb\lib. Confirmar que se hayan agregado dichas libreras en la ventana de propiedades del proyecto, si es as,
entonces se pueden guardar los cambios

Pantalla 21. Agregar libreras de Bases de Datos al proyecto

Una vez hecho esto se proceder a realizar una

clase Java que permita manipular la base de datos de
forma autnoma. Este paso lo que har es que dentro
de la clase pondr tantos atributos como campos tenga
la tabla que se cre anteriormente. Para ello har falta
dar clic derecho sobre el proyecto, situarse sobre
New y dar clic en Entity Classes from Darabase Se abrir una ventana donde deber elegirse
la base de datos, y posteriormente seleccionar la tabla,
usando el botn [Add >], para que pase a la columna Pantalla 22. Crear una clase Java a partir de la BD
de tablas seleccionadas.
En el siguiente paso de esta ventana solo har
falta indicar el nombre del paquete donde se almacenarn todas las dependencias. Para este ejemplo se us el
nombre datos.

Pantalla 23. Seleccionar tablas de la BD

Pantalla 24. Configurar las clases y paquetes

01 de febrero de 2015

Pgina 5 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

El siguiente paso de esta ventana no se realizan modificaciones en las opciones de mapeo a la base de datos. Una
vez que finalice el proceso, se podr observar en el panel del
proyecto, dentro de Source Package tanto el paquete datos que fue recin creado y contiene la clase generada para
manipular la base de datos, as como el paquete service que
tambin fue recin creado y contiene las diferentes vistas
para que se comunique el servicio web .
Pantalla 25. Concluir creacin de clase de
BD.

Pantalla 26. Archivos recin creados incluida la clase Java para manipular la BD

1.4.
Crear el servicio web RESTFul
Llegando a este punto, la creacin del nuevo servicio
web usando REST es muy fcil. El primer paso dar
clic derecho sobre el proyecto para agregar un
RESTful Web Services from Entity Classes, es
decir una manera de crear el servicio web basndose
en los parmetros que aparecen en la clase Java que
se cre con anterioridad. Solo har falta indicar la
Pantalla 27. Crear un servicio web REST
clase que ser usada y el nombre del paquete de las
libreras.

Pantalla 28. Seleccionar clase Java de la BD

01 de febrero de 2015

Pantalla 29. Indicar el nombre del paquete

Pgina 6 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

Si todo sali bien, debera generarse el

nuevo servicio web REST como se muestra en la imagen.
Para probar el servicio web REST
habr que dar clic derecho sobre el proyecto y elegir la opcin Test RESTful
Web Services, que previo a abrir el navegador preguntar en dnde se generar el
Cliente para hacer el Test. Si se conserva
Pantalla 31. Servicio web la segunda opcin por default, se generaPantalla 30. Probar el servicio
REST recin creado
rn ms archivos en el proyecto que servi- web REST
rn para realizar las pruebas.

Pantalla 32. Eleccin de la ubicacin para hacer las pruebas, y compilacin exitosa

1.5.

Pruebas de servicio web REST

Pantalla 33. Apertura de la pgina para hacer pruebas

Pantalla 34. Manipulacin de datos por medio de la llave primaria de la tabla

01 de febrero de 2015

Pgina 7 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

Pantalla 35. Obtener informacin formateado con JSON

Pantalla 36. Agregar un nuevo registro a la base de datos en formato XML

Pantalla 37. Consulta de datos despus de haber hecho un PUT para agregar un nuevo registro

01 de febrero de 2015

Pgina 8 de 9

Por: Hctor Garduo Real

Mster en Direccin e Ingeniera de Sitios Web
Servicios Web y Arquitecturas REST

Pantalla 38. Consulta de registros usando la URL para pasar parametros (http://localhost:8080/TitulacionAlumnos/websources/datos.titulacion/1)

01 de febrero de 2015

Pgina 9 de 9