Spring Boot efficient search API

Spring Boot: ¿Cómo diseñar una API REST eficiente?

Las colecciones de recursos suelen ser enormes, y cuando es necesario recuperar algunos datos de ellas, no sería muy eficiente obtener siempre la lista completa y buscar elementos específicos en ella. Por lo tanto, deberíamos diseñar una API de búsqueda optimizada.

• Filtración:

  • Limite los resultados de la consulta por parámetros (por ejemplo, país, fecha de creación).

    GET /api/cars ? country=Japan
    GET /api/cars ? createDate=2019-11-11

• Clasificación:

  • Ordene los resultados de forma ascendente o descendente según los parámetros elegidos (por ejemplo, por fecha).

    GET /api/cars ? sort=createDate,asc
    GET /api/cars ? sort=createDate,desc

• Paginación:

  • Utilice "límite" para restringir los resultados y "compensación" para especificar qué parte del rango de resultados mostrar.

    GET /api/cars ? limit=100
    GET /api/cars ? offset=2

Combina características:

GET /api/cars ? country=Japan & sort=createDate,desc & limit=100 & offset=2

Resultados en la lista de 100 automóviles de Japón, ordenados por fecha de creación en orden descendente, a partir de la segunda página (registros 101-200).

Cómo ejecutar el proyecto

Clonar código fuente de git

$ git clone https://github.com/Raouf25/Spring-Boot-efficient-search-API.git

Construir imagen de Docker

$ docker build -t= " spring-boot-efficient-search-api " --force-rm=true .

Este comando ejecuta Maven build para crear un paquete JAR y compila la imagen de Docker.

Nota: El comando inicial puede tardar en descargar la imagen base de DockerHub

Ejecutar contenedor Docker

$ docker run -p 8080:8080 -it --rm spring-boot-efficient-search-api

Solicitud de prueba

$ curl localhost:8080/api/cars/1

Respuesta:

{
   "id" : 1 ,
   "manufacturer" : " Acura " ,
   "model" : " Integra " ,
   "type" : " Small " ,
   "country" : " Japan " ,
   "createDate" : " 1931-02-01 "
}

Detener contenedor Docker

docker stop $( docker container ls | grep " spring-boot-efficient-search-api:* " | awk ' { print $1 } ' ) 

Demostración en vivo

Este proyecto se implementa en https://spring-boot-ficient-search-api.fly.dev/api/cars

Pruebe: enlace de demostración

Repositorio de imágenes de Docker

Imagen de Docker: raouf25/spring-boot-ficient-search-api

Consulte la sección Comandos de Docker para extraer, ejecutar y consultar la API mediante cURL y jq.

Licencia

Para obtener más detalles, consulte esta publicación mediana .

Api de búsqueda eficiente de Spring Boot Copyright © 2020 por Abderraouf Makhlouf [email protected]