Lekce 24 - REST API v Java Spring Boot - Filtrace filmů

V předchozí lekci, REST API v Java Spring Boot - Úprava a mazání filmů, jsme si přidali možnost mazání a úpravu filmů.

V tomto Java Spring Boot tutoriálu se podíváme na filtrování filmů pomocí filtračních parametrů, které nám klient posílá. Zatím mu totiž vrátíme vždy všechny filmy z databáze a filtrační parametry ignorujeme. Filtr si vytvoříme pomocí vlastního SQL příkazu za pomocí PagingAndSortingRepository.

Úprava endpointu getAllMovies()

Pojďme tedy upravit endpoint GET na /api/movies, který vrací filmy. Nejdříve si musíme zjistit, jak nám klient říká, že chce výsledky filtrovat. S tím nám opět pomůže dokumentace k danému API. Vidíme, že klient nám do URL adresy může vložit parametry pomocí tzv. query stringu.

Query string

Query string je alternativní způsob zadávání parametrů do URL adresy, kdy je každý parametr pro přehlednost pojmenovaný. Pokud si uživatel chce např. vypsat všechny filmy od režiséra s id 1 a zároveň jen od roku 2000, pošle požadavek na naše API na následující adresu:

/api/movies?directorID=1&fromYear=2000

Query string se píše za URL adresu pomocí znaku otazníku ?, za kterým následují jednotlivé parametry oddělené ampersandy &. Parametr obsahuje vždy jeho jméno, znak = a jeho hodnotu. Pro filtrování dat je query string typické řešení, jelikož nevíme, které parametry budou zadané a které ne (uživatel chce např. filtrovat filmy jen podle žánru). Kdybychom používali klasické parametry URL adresy oddělené lomítky / jako doposud, nevěděli bychom, který filtr byl zadán.

...konec náhledu článku...
Pokračuj dál