Spring Boot efficient search API

Spring Boot: จะออกแบบ REST API ที่มีประสิทธิภาพได้อย่างไร

การรวบรวมทรัพยากรมักจะมีปริมาณมหาศาล และเมื่อต้องดึงข้อมูลบางอย่างออกมา การดึงรายการทั้งหมดและเรียกดูรายการเฉพาะเสมอไปจะไม่มีประสิทธิภาพมากนัก ดังนั้นเราจึงควรออกแบบ Search API ที่ปรับให้เหมาะสม

• การกรอง:

  • จำกัดผลการค้นหาให้แคบลงตามพารามิเตอร์ (เช่น ประเทศ วันที่สร้าง)

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

• การเรียงลำดับ:

  • เรียงลำดับผลลัพธ์จากน้อยไปหามากหรือจากมากไปน้อยตามพารามิเตอร์ที่เลือก (เช่น ตามวันที่)

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

• เพจ:

  • ใช้ "limit" เพื่อจำกัดผลลัพธ์ และใช้ "offset" เพื่อระบุส่วนของช่วงผลลัพธ์ที่จะแสดง

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

รวมคุณสมบัติ:

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

ผลลัพธ์อยู่ในรายชื่อรถยนต์ 100 คันจากประเทศญี่ปุ่น เรียงตามวันที่สร้างจากมากไปน้อย เริ่มจากหน้าที่ 2 (บันทึก 101-200)

วิธีการดำเนินโครงการ

โคลนซอร์สโค้ดจาก git

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

สร้างอิมเมจนักเทียบท่า

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

คำสั่งนี้รัน Maven build เพื่อสร้างแพ็คเกจ JAR และสร้างอิมเมจ Docker

หมายเหตุ: คำสั่งเริ่มต้นอาจต้องใช้เวลาในการดาวน์โหลดอิมเมจพื้นฐานจาก DockerHub

เรียกใช้คอนเทนเนอร์นักเทียบท่า

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

แอปพลิเคชันทดสอบ

$ curl localhost:8080/api/cars/1

การตอบสนอง:

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

หยุดคอนเทนเนอร์นักเทียบท่า

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

การสาธิตสด

โปรเจ็กต์นี้ปรับใช้บน https://spring-boot-efficient-search-api.fly.dev/api/cars

ลอง: ลิงค์สาธิต

พื้นที่เก็บข้อมูลรูปภาพนักเทียบท่า

ภาพนักเทียบท่า: raouf25/spring-boot-efficient-search-api

โปรดดูส่วนคำสั่ง Docker สำหรับการดึง เรียกใช้ และสืบค้น API โดยใช้ cURL และ jq

ใบอนุญาต

สำหรับรายละเอียดเพิ่มเติม โปรดดู โพสต์ขนาดกลาง นี้

Spring Boot Efficient Search Api ลิขสิทธิ์ © 2020 โดย Abderraouf Makhlouf [email protected]