Spring Boot efficient search API

Spring Boot: Como projetar uma API REST eficiente?

As coleções de recursos costumam ser enormes e, quando alguns dados precisam ser recuperados delas, não seria muito eficiente obter sempre a lista completa e procurá-la em busca de itens específicos. Portanto, devemos projetar uma API de pesquisa otimizada.

• Filtragem:

  • Limite os resultados da consulta por parâmetros (por exemplo, país, data de criação).

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

• Classificação:

  • Classifique os resultados em ordem crescente ou decrescente pelos parâmetros escolhidos (por exemplo, por data).

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

• Paginação:

  • Use “limit” para restringir resultados e “offset” para especificar qual parte do intervalo de resultados mostrar.

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

Combine recursos:

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

Resultados na lista dos 100 carros do Japão, ordenados por data de criação em ordem decrescente, a partir da segunda página (registros 101-200).

Como executar o projeto

Clonar código fonte do git

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

Construir imagem Docker

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

Este comando executa a construção do Maven para criar um pacote JAR e construir a imagem Docker.

Nota: o comando inicial pode levar algum tempo para baixar a imagem base do DockerHub

Execute o contêiner Docker

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

Aplicação de teste

$ curl localhost:8080/api/cars/1

Resposta:

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

Pare o contêiner Docker

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

Demonstração ao vivo

Este projeto está implantado em https://spring-boot-efficient-search-api.fly.dev/api/cars

Experimente: Link de demonstração

Repositório de imagens Docker

Imagem Docker: raouf25/spring-boot-efficient-search-api

Consulte a seção Comandos do Docker para obter, executar e consultar a API usando cURL e jq.

Licença

Para mais detalhes, consulte esta postagem média .

API de pesquisa eficiente do Spring Boot Copyright © 2020 por Abderraouf Makhlouf [email protected]