...

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

Devolver ResponseEntity

En los métodos en los que devolvamos datos, 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 unResponseEntityque devuelva un objetoUsuarioDTO, y códigoOK 200:

@GetMapping(value = "/usuarios", params = "login")
public ResponseEntity<UsuarioDTO> usuariosLogin(@RequestParam login) {
  // ...
  return new ResponseEntity<>(usuarioDto, HttpStatus.OK);
}

También podríamos mandar un400 Forbiddenasí:

return new ResponseEntity<>(HttpStatus.FORBIDDEN);

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 etiquetasetiquetas @GetMapping, @PostMapping,@PutMappingy @PutMapping y @DeleteMapping, para los diferentes tipos de peticiones. En estas anotaciones pondremos la ruta a la que tendrá que hacerse cada petición. Por defecto, estas rutas irán después del dominio. Si queremos añadir una ruta base de la que partan todas las rutas de estos métodos podemos añadirlo en el archivoapplication.properties:

server.servlet.context-path=/rest/v1.0

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<>ResponseEntity.ok(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, tenemostenemos 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ónanotació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 enen localhost:8080):

http://localhost:8080/titulaciones/12312300A

@RequestParam

La otra opción eses 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, pondremospondremos required = true:

@GetMapping("/titulaciones")
public List<AlumnoTitulacionDTO> getTitulaciones(@RequestParam(required = true) String dni) {
    // ...
}

...

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 diferentesdiferentes @RequestParam. Para ello, no nos vale sólo con tener diferentes argumentos, hay que indicarlos dentro de la anotaciónanotación @GetMapping, concon params, y tendremos que tener la ruta enen 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ónanotación @RequestHeader. Dentro de ésta pondremos el nombre del header enen value, y podemos especificar si es obligatorio que se incluya dicho header concon 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<>ResponseEntity.ok(alumnoTitulacionRepository.findDni( claims.getSubject() ), HttpStatus.OK);
}
</java>
 
==== Datos en el body: @RequestBody ====
En caso de que hagamos un post, el cuerpo del mensaje se especificará con 

Datos en el body: @RequestBody

En caso de que hagamos un post, el cuerpo del mensaje se especificará con ''@RequestBody'':

<code java>
@PostMapping("/borrarUsuariocrearUsuario")
public void borrarUsuariocrearUsuario(@RequestBody UsuarioDTO usuario) {
    usuarioRepo.deletecreate(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

• GUÍA DE MANEJO DE ERORES EN FUNDEWEBJS

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 ResponseEntity.ok(usuarioDto);
}

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 inclirá incluirá en el JSON de respuesta. Si lo que queremos es devolver propiedades según la ocasión, podemos hacer uso de las vistas.

...

Después, en el modelo, en el getter de cada propiedad que queramos mostrar con cada vista, debemos añadir la etiquetaetiqueta @JsonView(Views.Detalle.class), poniendo la clase correspondiente:

...

Más información sobre las Views aquí.

Cliente REST en Spring Boot

@Configuration
public class RestTemplateConfig {

    @Bean
    public RestTemplate restTemplate() {
	return new RestTemplate();
    }
}

@Autowired
private RestTemplate restTemplate;

// Uri
final URI uri = UriComponentsBuilder.fromHttpUrl( url ).path( "/" + "pidAplicationid" ).path( "/firma" )
		.queryParam( "parametro", "valor" ).queryParam( "otroParametro", "otroValor" ).build().encode().toUri();

// HEADERS
final HttpHeaders headers = new HttpHeaders();
// Ponemos el tipo del contenido que irá en el body
headers.setContentType( MediaType.APPLICATION_JSON );
// Para indicar el accept, pide una lista de MediaType
final ArrayList<MediaType> listaAccept = new ArrayList<>();
listaAccept.add( MediaType.APPLICATION_JSON );
headers.setAccept( listaAccept );
// Añadimos los headers que queramos con nombre-valor de esta manera
headers.add( "X-Client-Id", ficha.getAplicacionId );

// HttpEntity
final HttpEntity<String> httpEntity = new HttpEntity<>( objeto, headers );

final HttpEntity<?> httpEntity = new HttpEntity<>( headers );

ResponseEntity<String> response1 = restTemplate.getForEntity( uri, String.class );
ResponseEntity<String> response2 = restTemplate.postForEntity( uri, httpEntity, String.class );
restTemplate.put( uri, httpEntity );
restTemplate.delete( uri );

final ResponseEntity<String> response = restTemplate.exchange( uri, HttpMethod.GET, httpEntity, String.class );