Versiones comparadas

Versión anterior 20

changes.mady.by.user Guillermo Castillo García

Guardado el

comparado con

Nueva versión Actual

changes.mady.by.user Ramón Ginel Gea

Guardado el

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

Tabla de contenidos

...


Info
titleObtener 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


Advertencia
titleDocumentar 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.

...

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. 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 archivo application.properties:

...

Veamos un ejemplo sencillo:

Bloque de código
languagejava
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

...

Bloque de código
languagejava
@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);
}

Datos en el body: @RequestBody

...

Bloque de código
languagejava
@PostMapping("/borrarUsuariocrearUsuario")
public void borrarUsuariocrearUsuario(@RequestBody UsuarioDTO usuario) {
    usuarioRepo.deletecreate(new Usuario(usuario));
}

...

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.

...

Bloque de código
languagejava
@GetMapping(value = "/usuarios", params = "login")
public ResponseEntity<UsuarioDTO> usuariosLogin(@RequestParam login) {
  // ...
  return new ResponseEntity<>ResponseEntity.ok(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. 

...

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

Cliente REST en Spring Boot



Advertencia

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.


Expandir
titleClick aquí para ver explicación antigua

Para consumir otro servicio REST desde el propio backend, a falta de realizar más pruebas, la forma que tendremos de hacerlo será utilizando RestTemplate:, que lo tendremos como un bean en una clase de configuración que tendremos que crear:

Bloque de código
languagejava
@Configuration
public class RestTemplateConfig {

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

Después, en la clase en la que vayamos a utilizarlo, sólo tendremos que cargarlo con Autowired:

Bloque de código
languagejava
@Autowired
private RestTemplate restTemplate;

Para utilizarlo, formamos el URI con UriComponentsBuilder:

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

Con .path, se concatena lo que indiquemos al path, y con .queryParam indicamos los parámetros que se pasan por la propia url.

Podemos añadir headers con HttpHeaders:

Bloque de código
languagejava
// 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 );

Los headers los incluiremos en un objeto HttpEntity, junto con el objeto a pasar (el body) si se pasa alguno:

Bloque de código
languagejava
// HttpEntity
final HttpEntity<String> httpEntity = new HttpEntity<>( objeto, headers );

En el caso de que sólo queramos pasar los headers, HttpEntity dispone de un constructor para ello, con el que no haría falta parametrizar el tipo del objeto que se le pasa como cuerpo del mensaje, pues no habrá ninguno. La sintaxis sería la siguiente:

Bloque de código
languagejava
final HttpEntity<?> httpEntity = new HttpEntity<>( headers );

Para lanzar las peticiones tenemos diferentes opciones. En primer lugar, disponemos de cuatro métodos básicos para hacer GET, POST, PUT, DELETE:

Bloque de código
languagejava
ResponseEntity<String> response1 = restTemplate.getForEntity( uri, String.class );
ResponseEntity<String> response2 = restTemplate.postForEntity( uri, httpEntity, String.class );
restTemplate.put( uri, httpEntity );
restTemplate.delete( uri );

Para las operaciones básicas estos métodos pueden ser útiles, pero como vemos, solo podemos pasar el objeto HttpEntity haciendo POST, pero podemos necesitar añadir headers en un GET para, por ejemplo, pasar un token de autenticación. Para hacer esto, podemos utilizar el método .exchange, al que tenemos que indicarle la Uri, el método http a utilizar, el objeto HttpEntity a pasar (puede ser null) y la clase del objeto que se espera recibir:

Bloque de código
languagejava
final ResponseEntity<String> response = restTemplate.exchange( uri, HttpMethod.GET, httpEntity, String.class );

Como vemos, estamos utilizando el tipo ResponseEntity. RestTemplate tiene métodos para obtener directamente el objeto del tipo que se espera, pero ResponseEntity nos permite explorar todos los detalles del mensaje, y podemos obtener el objeto correspondiente con .getBody().

Ver también => Logging de Peticiones y Respuestas en clientes con RestTemplate.