GeoBack. Un sencillo ejemplo. 3ª parte

En este tercer Post de pruebas de GeoBack, vamos a realizar pruebas a nuestra API REST con Postman. Es una herramienta muy útil, que nos permite realizar peticiones HTTP hacia direcciones URL donde tengamos desplegadas nuestras APIs .

Ejecutar con SpringBoot y Maven.

Vamos a compilar y ejecutar nuestra aplicación. Al estar desarrollado con Spring Boot, no necesitamos nada más que Maven para compilar, ya que disponemos de un Tomcat embebido en nuestro JAR. Para compilar nuestro módulo, nos ponemos en la carpeta del proyecto y simplemente ejecutamos este comando:

mvn package

Si queremos evitar que nos ejecute los test, lo haremos añadiendo esta opción:

mvn package  -Dmaven.test.skip=true

Ahora, simplemente tenemos que ejecutar nuestro JAR que está en la carpeta target:

java -jar geoback-0.0.1-SNAPSHOT.jar

Ya tenemos nuestra aplicación disponible en HTTP.

Pruebas con Postman.

Postman lo puedes descargar directamente de su web. Es una de las mejores herramientas para probar APIs. En su web tenéis documentación por si queréis profundizar en su uso. Tiene interesantes características, si os registráis, pero para las pruebas que vamos a hacer no lo necesitaremos.

Vamos a hacer las pruebas más básicas posibles, que no es más que probar cada uno de los métodos del Controller. Pero antes de nada, vamos a fijarnos bien en cómo tienen que estar construidos los request para acceder con nuestro token.

Como véis en la imagen, hemos creado un Environment en el que incluir las propiedades comunes a todos los request. En el recuadro rojo está el menú para gestionar los Environments. Es totalmente opcional, pero recomendable, utilizarlos.

Nuestras propiedades van a ser las siguentes:

DEVHOST: localhost

DEVPORT: 9001

ENVIRONMENT: layer/geojson

JWT_AUTH: 

Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJIZWN0b3IiLCJ1c2VySWQiOiIxMjMiLCJyb2xlIjoiQURNSU4ifQ.Rz1rY8WPsuOjUxs12qbn2QwspmCXRZgU_SLxXoc_Wv_lzjT-MZQV9lHz41ReucM4uB_ZEOyuZN_Ba8KibOmqIA

PROTOCOL: http

Lo más destacable es el parámetro JWT_AUTH. Aquí tenemos que indicar el Token con el que vamos a realizar los request.

Ya vimos en el Post anterior, cómo se generan los Token JWT de nuestro ejemplo. Ahora,  generaremos los request con Postman. Como hemos indicado anteriormente, haremos una prueba por cada método del CRUD. Cada request irá con un método diferente (POST, GET, PUT y DELETE) y la correspondiente URL.

Hay que fijarse, principalmente, en dos pestañas. La primera es la pestaña Headers, en la cual tendremos que añadir nuestra autenticación, generada anteriormente, (no olvidar la palabra Bearer delante del Token) e indicar que estamos enviado los datos en formato JSON. Esto es común a todos los request que hagamos.

La segunda pestaña importante es la pestaña Body. En este caso tendremos que indicar que estará en formato JSON y, seleccionando raw, escribiremos el cuerpo de nuestro request (que en este caso, tiene que ser una representación en JSON de un objeto de la clase Layer).

Vayamos con las pruebas.

Probando método 1: Create

Creamos un Layer con los siguientes datos:

Method: POST

URL: http://localhost:9001/layer/crud/

Body: {
       "token":"PRUEBAS_CRUD",
       "name":"createTest",
       "description":"Test de prueba del metodo create.",
       "series":"PRUEBAS",
       "geoData":{
                  "type": "FeatureCollection",
                  "features": [{
                                "type": "Feature",
                                "geometry": {"type":"Polygon","coordinates":[[[-9.034818,41.880571],[-8.984433,42.592775],[-9.392884,43.026625],[-7.97819,43.748338],[-6.754492,43.567909],[-5.411886,43.57424],[-4.347843,43.403449],[-3.517532,43.455901],[-1.901351,43.422802],[-1.502771,43.034014],[0.338047,42.579546],[0.701591,42.795734],[1.826793,42.343385],[2.985999,42.473015],[3.039484,41.89212],[2.091842,41.226089],[0.810525,41.014732],[0.721331,40.678318],[0.106692,40.123934],[-0.278711,39.309978],[0.111291,38.738514],[-0.467124,38.292366],[-0.683389,37.642354],[-1.438382,37.443064],[-2.146453,36.674144],[-3.415781,36.6589],[-4.368901,36.677839],[-4.995219,36.324708],[-5.37716,35.94685],[-5.866432,36.029817],[-6.236694,36.367677],[-6.520191,36.942913],[-7.453726,37.097788],[-7.537105,37.428904],[-7.166508,37.803894],[-7.029281,38.075764],[-7.374092,38.373059],[-7.098037,39.030073],[-7.498632,39.629571],[-7.066592,39.711892],[-7.026413,40.184524],[-6.86402,40.330872],[-6.851127,41.111083],[-6.389088,41.381815],[-6.668606,41.883387],[-7.251309,41.918346],[-7.422513,41.792075],[-8.013175,41.790886],[-8.263857,42.280469],[-8.671946,42.134689],[-9.034818,41.880571]]]},
                                "properties": {}
                              }]
                  }
      }

Comprobamos que la respuesta obtenida es un Layer, representado en JSON, como indicamos en el método del Controller, pero con el id (este será el id que utilizaremos en las siguientes pruebas).

{
    "id": "5aa6c86ee285aa1dc419ab80",
    "token": "PRUEBAS_CRUD",
    "name": "createTest",
    "series": "PRUEBAS",
    "description": "Test de prueba del metodo create.",
    "geoData": {
                "type": "FeatureCollection",
                "features": [{
                              "type": "Feature",
                              "geometry": {
                                           "type": "Polygon",
                                           "coordinates": [[[
                                                          -9.034818,
                                                          41.880573
                                                          ],
                                                          [
                                                          -8.984433,
                                                          42.592777
                                                          ],
                                                          ...

 

Probando método 2: Read

Leemos el Layer que hemos creado en la prueba anterior, indicando en la URL (método GET) el id por el que vamos a buscar.

Method: GET

URL: http://localhost:9001/layer/crud/5aa6c86ee285aa1dc419ab80

Body: {}

La respuesta será exactamente la misma que en el método Create.

Probando método 3: Update

Ahora, vamos a añadir una propiedad a nuestro Layer. Haremos unos cambios en la descripción, y lo actualizaremos.

Method: PUT

URL: http://localhost:9001/layer/crud/

Body: {
       "id":"5aa6c86ee285aa1dc419ab80",
       "token":"PRUEBAS_CRUD",
       "name":"updateTest",
       "description":"Test de prueba del metodo update.",
       "series":"PRUEBAS",
       "geoData":{
                  "type": "FeatureCollection",
                  "features": [{
                                "type": "Feature",
                                "geometry": {"type":"Polygon","coordinates":[[[-9.034818,41.880571],[-8.984433,42.592775],[-9.392884,43.026625],[-7.97819,43.748338],[-6.754492,43.567909],[-5.411886,43.57424],[-4.347843,43.403449],[-3.517532,43.455901],[-1.901351,43.422802],[-1.502771,43.034014],[0.338047,42.579546],[0.701591,42.795734],[1.826793,42.343385],[2.985999,42.473015],[3.039484,41.89212],[2.091842,41.226089],[0.810525,41.014732],[0.721331,40.678318],[0.106692,40.123934],[-0.278711,39.309978],[0.111291,38.738514],[-0.467124,38.292366],[-0.683389,37.642354],[-1.438382,37.443064],[-2.146453,36.674144],[-3.415781,36.6589],[-4.368901,36.677839],[-4.995219,36.324708],[-5.37716,35.94685],[-5.866432,36.029817],[-6.236694,36.367677],[-6.520191,36.942913],[-7.453726,37.097788],[-7.537105,37.428904],[-7.166508,37.803894],[-7.029281,38.075764],[-7.374092,38.373059],[-7.098037,39.030073],[-7.498632,39.629571],[-7.066592,39.711892],[-7.026413,40.184524],[-6.86402,40.330872],[-6.851127,41.111083],[-6.389088,41.381815],[-6.668606,41.883387],[-7.251309,41.918346],[-7.422513,41.792075],[-8.013175,41.790886],[-8.263857,42.280469],[-8.671946,42.134689],[-9.034818,41.880571]]]},
                                "properties": {"times":1}
                              }]
                 }
      }

La respuesta será nuestro Layer ya actualizado.

Probando método 4: Delete

Ya sólo queda eliminar el Layer de prueba. Para ello, únicamente llamamos al método delete, indicando en la URL el id de nuestro Layer (igual que en método Read)

Method: DELETE

URL: http://localhost:9001/layer/crud/5aa6c86ee285aa1dc419ab80

Nos devuelve un Status 200 OK. Podemos comprobar que se ha eliminado, entrando en nuestra base de datos.

Y así finalizamos este ejemplo, que esperamos os sea de utilidad y como siempre, os emplazamos a la zona de comentarios para que compartáis vuestras dudas o impresiones sobre este tema.

GeoBack. Ejemplo 1/3, ejemplo 2/3.