Obtener token en métodos REST
Para ver cómo obtener tanto el token en los métodos REST, podemos verlo en la guía de login: Login con OAuth en Spring Boot
Documentar APIs
Se deben documentar las APIs con OpenAPI, para lo que tenemos otra guía: Documentar APIs con OPENAPI
Para la implementación de los servicios REST desde el backend Spring, se ha optado por usar las librerías nativas (Spring) incluidas ya que engloban todas las necesidades funcionales a la hora de crear servicios y/o clientes Spring integradas con el framework y con numerosas facilidades que reducen el tiempo de desarrollo.
Buenas prácticas
Para crear nuestros servicios REST debemos seguir las buenas prácticas que están definidas en esta página de la wiki: Buenas prácticas con servicios REST
Controlador REST en Spring Boot
En Spring Boot, las peticiones HTTP se gestionan por medio de controladores. En nuestro caso la clase que hará de controlador REST deberá estar precedida por la anotación @RestController, y por @RequestMapping, que indicará la ruta base.
Para los métodos que contendrán el código a ejecutar al recibir peticiones disponemos de las etiquetas @GetMapping, @PostMapping, @PutMapping y @DeleteMapping, para los diferentes tipos de peticiones. En estas anotaciones pondremos la ruta a la que tendrá que hacerse cada petición.
Veamos un ejemplo sencillo:
package com.example.restservice;
import java.util.concurrent.atomic.AtomicLong;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping( "${app.server.path}" )
public class GreetingController {
private static final String template = "Hello, %s!";
private final AtomicLong counter = new AtomicLong();
@GetMapping("/greeting")
public ResponseEntity<Greeting> greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
Greeting greeting = new Greeting(counter.incrementAndGet(), String.format(template, name));
return new ResponseEntity<>(greeting, HttpStatus.OK);
}
}
Parámetros en la URL
@PathVariable
Para añadir parámetros en la ruta de la petición, tenemos dos opciones. En primer lugar, tenemos PathVariable. Cuando especifiquemos la ruta, pondremos entre corchetes estas variables, y como parámetro del método Java lo especificaremos con el mismo nombre, precedido de la anotación @PathVariable:
@GetMapping("/titulaciones/{dni}")
public List<AlumnoTitulacionDTO> getTitulaciones(@PathVariable String dni) {
// ...
}
Un ejemplo de petición quedaría así (suponiendo que tenemos la aplicación corriendo en localhost:8080):
http://localhost:8080/titulaciones/12312300A
@RequestParam
La otra opción es RequestParam, que funciona de manera similar, pero sólo se indica en los parámetros de la función Java. Si queremos que sea obligatorio incluir esa variable en la petición, pondremos required = true:
@GetMapping("/titulaciones")
public List<AlumnoTitulacionDTO> getTitulaciones(@RequestParam(required = true) String dni) {
// ...
}
Y ahora la petición sería la siguiente:
http://localhost:8080/titulaciones?dni=12312300A
Estos parámetros irán después de ?, y si tenemos varios los separaremos con &.
Métodos REST con mismo nombre pero diferentes parámetros
Podemos definir diferentes métodos Java con la misma ruta de método REST, pero con diferentes @RequestParam. Para ello, no nos vale sólo con tener diferentes argumentos, hay que indicarlos dentro de la anotación @GetMapping, con params, y tendremos que tener la ruta en value:
@GetMapping("/usuarios")
public List<UsuarioDTO> usuarios() {
// ...
}
@GetMapping(value = "/usuarios", params = "login")
public UsuarioDTO usuariosLogin(@RequestParam login) {
// ...
}
De este modo podemos evitar tener métodos Java excesivamente largos por tener que comprobar diferentes parámetros y ejecutar el código correspondiente.
Headers de la petición: @RequestHeader
Para utilizar los valores de los headers de la petición, disponemos de la anotación @RequestHeader. Dentro de ésta pondremos el nombre del header en value, y podemos especificar si es obligatorio que se incluya dicho header con required. Por ejemplo, podemos utilizarlo para obtener el token de autenticación:
@GetMapping( "/dniAlumno" )
public ResponseEntity<String> dniAlumno( @RequestHeader( value = "auth-token", required = true ) String tokenCodificado ) {
final Claims claims = jwtTokenUtil.comprobarToken( tokenCodificado );
if(claims == null)
return null;
return new ResponseEntity<>(alumnoTitulacionRepository.findDni( claims.getSubject() ), HttpStatus.OK);
}
Datos en el body: @RequestBody
En caso de que hagamos un post, el cuerpo del mensaje se especificará con ''@RequestBody'':
@PostMapping("/borrarUsuario")
public void borrarUsuario(@RequestBody UsuarioDTO usuario) {
usuarioRepo.delete(new Usuario(usuario));
}
La respuesta que se enviará a la petición, si la hay, será el objeto, con sus atributos y valores, automáticamente en formato JSON.
Devolver ResponseEntity o ResponseStatusException
En los métodos en los que devolvamos datos, si se devuelven los datos correctamente devolveremos objetos tipo ResponseEntity. Este tipo nos da más flexibilidad, permitiendo modificar la respuesta HTTP entera, controlando el código que se devuelve, los headers y los datos del body.
Un ejemplo de uso sería el siguiente. Para crear un ResponseEntity que devuelva un objeto UsuarioDTO, y código OK 200:
@GetMapping(value = "/usuarios", params = "login")
public ResponseEntity<UsuarioDTO> usuariosLogin(@RequestParam login) {
// ...
return new ResponseEntity<>(usuarioDto, HttpStatus.OK);
}
En el caso de que queramos devolver un error, por ejemplo, un Forbidden porque el usuario que ha solicitado un recurso no tiene acceso, lanzaremos una excepción ResponseStatusException, pues esta nos ofrece más información en la respuesta que se da.
} catch (Exception e) {
throw new ResponseStatusException( HttpStatus.FORBIDDEN, "FORBIDDEN con ResponseStatusException", e);
}
Devolver diferentes propiedades
La primera opción que tenemos para personalizar la respuesta es la anotación @JsonIgnore que le podemos poner a los getters. Con ella, esa propiedad directamente no se incluirá en el JSON de respuesta. Si lo que queremos es devolver propiedades según la ocasión, podemos hacer uso de las vistas.
Para esto, en primer lugar, debemos crear una clase con los diferentes nombres de vistas que queramos utilizar como clases estáticas vacías:
public class Views {
public static class Id {}
public static class Tabla extends Id {}
public static class Detalle extends Id {}
}
Después, en el modelo, en el getter de cada propiedad que queramos mostrar con cada vista, debemos añadir la etiqueta @JsonView(Views.Detalle.class), poniendo la clase correspondiente:
@JsonView(Views.Detalle.class)
public ResponseEntity<String> getChkExcepciones() {
// ...
}
Por último, en el controlador REST, debemos etiquetar el método en el que queramos devolver las propiedades de una vista de la misma manera. Un ejemplo de código de un método completo sería este:
@JsonView(Views.Detalle.class)
public ResponseEntity<ChkLogDTO> getChkLogId (@PathVariable(required = true) Long id) {
// ...
}
Como en los servicios REST debemos devolver el DTO, y no la entidad, sólo será necesario incluir la etiqueta @JsonView en las clases DTO.
Más información sobre las Views aquí.
Cliente REST en Spring Boot
Este apartado queda obsoleto, se manendrá aquí temporalmente. RestTemplate queda obsoleto, hay que utilizar WebClient, está documentado en la siguiente página: WebClient - Cliente REST en Spring Boot