Spring Boot efficient search API

Spring Boot: Bagaimana cara merancang REST API yang efisien?

Koleksi sumber daya seringkali sangat besar, dan ketika beberapa data harus diambil darinya, akan menjadi tidak efisien jika selalu mendapatkan daftar lengkap dan menelusuri item tertentu. Oleh karena itu kita harus merancang API Pencarian yang dioptimalkan.

• Penyaringan:

  • Mempersempit hasil kueri berdasarkan parameter (misalnya, negara, tanggal pembuatan).

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

• Penyortiran:

  • Urutkan hasil secara menaik atau menurun berdasarkan parameter yang dipilih (misalnya berdasarkan tanggal).

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

• halaman:

  • Gunakan "batas" untuk membatasi hasil dan "offset" untuk menentukan bagian rentang hasil mana yang akan ditampilkan.

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

Gabungkan fitur:

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

Hasil daftar 100 mobil asal Jepang, diurutkan berdasarkan tanggal pembuatan dalam urutan menurun, mulai dari halaman kedua (catatan 101-200).

Cara Menjalankan Proyek

Kloning kode sumber dari git

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

Bangun gambar Docker

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

Perintah ini menjalankan Maven build untuk membuat paket JAR dan membangun image Docker.

Catatan: Perintah awal mungkin memerlukan waktu untuk mengunduh image dasar dari DockerHub

Jalankan Kontainer Docker

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

Aplikasi Uji

$ curl localhost:8080/api/cars/1

Tanggapan:

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

Hentikan Kontainer Docker

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

Demo Langsung

Proyek ini diterapkan di https://spring-boot-efisien-search-api.fly.dev/api/cars

Coba: Tautan Demo

Repositori Gambar Docker

Gambar Docker: raouf25/spring-boot-efisien-search-api

Lihat bagian Perintah Docker untuk menarik, menjalankan, dan menanyakan API menggunakan cURL dan jq.

Lisensi

Untuk lebih jelasnya silakan lihat posting media ini.

Spring Boot Pencarian Efisien Api Hak Cipta © 2020 oleh Abderraouf Makhlouf [email protected]