En este post construiremos un Servicio Web en Java bajo el estandar REST (Representational State Transfer), el cual hace uso del protocolo HTTP y proporciona un API con el cual se puede realizar diferentes operaciones entre la aplicación y el cliente. En esta oportunidad no usamos ningún tipo de base de datos, por lo que nuestro WebService se reducirá a operaciones GET, es decir para consultar recursos. EL formato de respuesta sera JSON.
Necesitamos
Nivel: Intermedio – Avanzado
Tiempo: 20 minutos
Paso 1. El Proyecto
Clic en menú Archivo → Nuevo Proyecto → En Categoría seleccionar Java Web → en Proyecto seleccionar Web Application, presionar [siguiente].
Como nombre de proyecto, colocamos «wsjava«, presionamos [siguiente].
Finalmente seleccionamos el servidor Apache Tomcat y presionamos [Terminar].
Paso 2. Clases y librerías
Al proyecto le agregamos una clase llamada «ApiREST» dentro el paquete «example.rest«, a continuación añadimos las librerías, Jersey 2.5.1 y Java-Json.
El proyecto queda de la siguiente forma:
Paso 3. El código
Nuestro API REST esta compuesto por una sola clase (creada en el paso 2) sin conexión a base de datos. El código es el siguiente:
package example.rest; import java.util.Random; import javax.ws.rs.core.Response; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import org.json.JSONException; import org.json.JSONObject; /** * @see https://www.jc-mouse.net/ * @author mouse */ @Path("/restapi") public class ApiREST { @GET @Path("/rnd") @Produces(MediaType.APPLICATION_JSON) /** * genera y retorna un numero aleatorio * @return Response */ public Response generateRndNumber(){ Random rnd = new Random(); return Response.ok( response("Numero Aleatorio", "", String.valueOf(rnd.nextDouble())), MediaType.APPLICATION_JSON).build(); } @GET @Path("/fibo/{value}") @Produces(MediaType.APPLICATION_JSON) /** * Sucesion de fibonacci * @param value numero entero * @return Response */ public Response getFibo(@PathParam("value") int value) { if(value<=0){ return Response.status(Response.Status.BAD_REQUEST) .entity( response("Fibonacci", String.valueOf(value), "El numero debe ser mayor que cero")).build(); } int fibo1 = 1; int fibo2 = 1; int aux = 1; String cadena = "1"; for (int i = 2; i <= value; i++) { fibo2 += aux; aux = fibo1; fibo1 = fibo2; cadena += " " + aux; } return Response.ok( response("Fibonacci", String.valueOf(value), cadena), MediaType.APPLICATION_JSON).build(); } /** * metodo privado para dar formato al JSON de respuesta * @param operation Operacion que se realiza en el APIREST * @param paramater parametro de entrada * @param result resultado de la operacion realizada * @return String Respuesta en formato JSON */ private String response(String operation, String parameter, String result) { JSONObject obj = new JSONObject(); try { obj.put("operation", operation); obj.put("parameter", parameter); obj.put("result", result); return obj.toString(4); } catch (JSONException ex) { System.err.println("JSONException: " + ex.getMessage()); } return ""; } }
Nuestra API consta de 2 métodos que podrán ser invocados desde una URL:
Paso 4. Configuración
web.xml: Este archivo contiene información sobre la estructura y las dependencias externas de los componentes web en el módulo y describe cómo se utilizan los componentes en tiempo de ejecución. Está contenido en el directorio WEB-INF.
Para crear un archivo web.xml, debemos hacer clic derecho sobre el proyecto → Nuevo → Otros. Buscar la categoría web → En tipo de archivo, seleccionar Standard Deployment Descriptor (web.xml), presionar [Terminar] para crear el archivo.
Reemplazamos el contenido por:
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1"> <!-- punto de entrada para la aplicacion --> <welcome-file-list> <welcome-file>index.html</welcome-file> <welcome-file>index.htm</welcome-file> <welcome-file>index.jsp</welcome-file> <welcome-file>default.html</welcome-file> <welcome-file>default.htm</welcome-file> <welcome-file>default.jsp</welcome-file> </welcome-file-list> <!-- características del servlet --> <servlet> <servlet-name>wsjava</servlet-name> <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class> <init-param> <param-name>jersey.config.server.provider.packages</param-name> <param-value>example.rest, com.jersey.jaxb, com.fasterxml.jackson.jaxrs.json</param-value> </init-param> <init-param> <param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name> <param-value>true</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <!-- asocia una URL a un servlet - Nombre del Servlet - URL asociado al Servlet --> <servlet-mapping> <servlet-name>wsjava</servlet-name> <url-pattern>/jcmouse/*</url-pattern> </servlet-mapping> </web-app>
Paso 5. Ejecución
Presionamos F6 para ejecutar el proyecto en el navegador.
Nos aparece la pagina web por defecto.
Para acceder a los recursos del API se usan URL (Uniform Resource Locator) los cuales nos permiten identificar de forma única un recurso, es decir:
{protocolo}://{dominio o hostname}[:puerto (opcional)]/{ruta del recurso}+{consulta de filtrado}
Por ejemplo, para acceder a un registro de una persona en especifico, podríamos escribir la siguient:
http://localhost:8084/api/persona/123
Existen reglas para el diseño de estas URI, por ejemplo:
Dicho esto, para poder acceder a nuestros dos recursos haremos lo siguiente:
Numero aleatorio
URL: http://localhost:8084/wsjava/jcmouse/restapi/rnd
Secuencia Fibonacci
URL: http://localhost:8084/wsjava/jcmouse/restapi/fibo/8
Si bien podemos probar los recursos de nuestro API desde un navegador, es mejor hacerlo usando un cliente especialmente diseñado para ello, entre las muchas aplicaciones que hay en internet, podemos hacer uso de Insomnia, que antes venia como complemento para Chrome pero ahora esta como aplicación independiente de escritorio.
Por ejemplo para el recurso de Fibonacci, ademas de darnos la respuesta preformateada, nos da el tamaño, tiempo de respuesta y el Código de Estado (200) que nos informa que la petición se ha realizado correctamente.
De la misma forma si ingresamos una petición incorrecta, (un numero negativo en el caso de Fibonacci), obtendremos como respuesta lo siguiente:
FIN
En este post crearemos una aplicación en Android Studio para conectarnos con nuestra base de datos de Firebase y leer al[...]
Un Action Provider es un elemento que habita en la Action Bar para incrementar la accesibilidad de nuestras aplicaciones[...]
Segunda y ultima parte del post dedicado a la creación de un microservicio en lenguaje java utilizando el framework Spar[...]
Java2d nos permite manipular imagenes y asi poder crear animaciones sencillas como muestra el siguiente video. Puedes de[...]
JavaMail es una expansión de Java que facilita el envío y recepción de e-mail desde código java. JavaMail implementa el[...]
En esta oportunidad dejamos las fuentes del Generador de Código de Control de Impuestos Bolivia (Facturación Virtual), e[...]