API příklad
Zde je ke stažení kolekce requestů a popis pro aplikaci Postman:
Nápověda
ZIP rozbalíme jak je, obsahuje:
- 2 obrázky v
img - 2 dokumenty v
doc - kolekci requestů a slovní návod pro Postman v
PD.postman_collection.json - slovní návod je navíc extra uložený v
example.md
slovní návod je psaný v markdown formátu. ten je čitelný i v obyčejném textovém editoru, ale pro lepší user experience je lepší ho vložit do nějakého markdown editoru, který ho instantně převede do html podoby.
pro kolekci requestů potřebujeme aplikaci Postman.
do Postmanu importujeme kolekci z PD.postman_collection.json. po “rozkliku” kolekce se zobrazí slovní návod.
důležitá je záložka Variables v Edit.
kolekce obsahuje několik proměnných, které mají ukázkové hodnoty. abychom mohli requesty volat, musíme jim nastavit vlastní, reálné hodnoty.
k tomu v Postman slouží Environments. hodnoty proměnných v našem Environment přebijí ukázkové hodnoty v kolekci. vytvoříme si Environment, zkopírujeme všechny proměnné z kolekce, a ujistíme se, že je environment zvolený jako aktivní. hodnoty proměnných budeme doplňovat podle návodu.
zavoláme první request autentizace. k tomu je potřeba vyplnit proměnné username a password.
pokud máme údaje správně, request vrátí 200 a autentizační token. jeho hodnotu zkopírujeme a vložíme do env proměnné token.
pokud zadáme chybné údaje, dostaneme 401 Invalid credentials.
token rovnou vyzkoušíme ve druhém requestu výpis kategorií.
pokud je token validní a platný, vrátí 200 a vidíme výpis kategorií.
pokud je token neplatný nebo prošlý, vrací 401.
pokračujeme requestem výpis kanceláře
a uložíme si identifikátory kanceláře a zodpovědné osoby.
a jdeme na request vytvoření dražby. k tomu nastavíme hodnoty proměnných office, category, person a number.
pokud jsou hodnoty ok, dostaneme 201. nyní zkopírujeme identifikátor vytvořené dražby a uložíme ho do proměnné auction.
ten najdeme v response header Link a v response body v poli slug.
dále postupujeme dle návodu. pokud se nám kdykoliv stane, že dostaneme odpověď 401 JWT token expired,
zopakujeme request autentizace, a uložíme nový token do proměnné token.
v krocích upload obrázku a upload dokumentu jsou předvyplněné soubory z příkladu, ale lze samozřejmě vybrat libovolný soubor,
který splňuje požadavky.
zakončíme krokem zveřejnění dražby. dostaneme 204.
že byla dražba zveřejněna ověříme na webu.