FLORES API Tutoriál - Spuštění Web API
Pokud jste provedli potřebná nastavení, můžete pokračovat spuštěním Web API serveru. V produkčním prostředí se standardně spouští jako služba, ale my si ho pro účely našeho příkladu spustíme jako aplikaci.
Podrobnosti o instalaci Web API jako služby viz , kap. Spuštění Web API serveru.
Spusťte příkazový řádek a přejděte do instalační složky ABRA Flores, ve které se nachází program ApiServerCmd.exe. Poté spusťte Web API server:
C:\ABRA Flores\ApiServerCmd.exe
Podrobnosti o spuštění pojmenovaných instancí s vlastní konfigurací viz Provoz více instancí Web API serveru.
V okně konzole se zobrazí informace o spuštění frameworku Javalin. Všimněte si informace o portu, na kterém server naslouchá. Mělo by se jednat o stejný port, který jste nastavili v předchozím kroku (v konfiguračním serveru APIServer.yaml).
Je spuštěn framework Javalin, http server (Web API server) naslouchá na portu 8082.
Okno konzole nezavírejte, Web API server byste tím ukončili.
Pokud se vám Web API server nepodařilo spustit (v okně příkazového řádku se zobrazily nějaké chyby), projděte si možné důvody uvedené v sekci TEST. Příčinu je možné zjišťovat též pomocí standardního logování systému ABRA Flores, viz též sekce TEST.
Dále viz . Kap.: Web API.
1. Povedlo se spuštění Web API serveru? Tj. rozběhl se framework Javalin a v okně konzole vidíte informaci o portu, na kterém Web API server naslouchá? Vidíte ve Správci úloh spuštěnou "OpenJDK Platform binary"?
Můžete pokračovat dál. Viz kap. FLORES API Tutoriál - Autentizace a kontrolní dotaz.
Pokud jste provedli správně nastavení dle kap. FLORES API Tutoriál - Nastavení a příprava rozhraní Web API, pak zkontrolujte následující:
-
Zda není v konfiguraci nastavený port (případně výchozí port 80) využíván jinou aplikací. Informace o obsazeném portu se zobrazí ve formě chyby (výjimky) v okně příkazové řádky při spouštění skriptu:
Web API server se nepodařilo spustit, protože port 80 využívá jiná aplikace.
V takovém případě může být řešením buď danou aplikaci (která port využívá) dočasně vypnout nebo změnit nastavení Web API na jiný port. Jak jsme zmínili v kap. FLORES API Tutoriál - Nastavení a příprava rozhraní Web API, defaultně je v šabloně nastavený port 80. Můžete si změnit port na nějaký dosud nevyužívaný, např. 8082. Tj. v souboru APIServer.yaml uvedete:
# server configuration server: # address and port to listen to ... port: 8082 ...Dále viz . Kap.: Nastavení Web API.
Pro výpis obsazených portů můžete využít např. příkaz netstat spouštěný z příkazové řádky.
-
Další příčinou může být firewall. V tom případě je třeba daný port ve firewallu povolit, tj. spustit konfigurační program "Firewall v programu Windows Defender s pokročilým nastavením" a přidat nové pravidlo.
Příklad nastavení pravidel firewallu ve Windows 10
Obdobný problém může způsobovat antivirový program.
-
Web API, které je součástí systému ABRA Flores od verze 21.3, není podmíněno provozem v síťovém režimu. Nicméně pokud aplikaci ABRA Flores v síťovém režimu provozujete, je zapotřebí před spuštěním Web API spustit aplikační server.
Pokud je v souboru Nexus.cfg parametr Local nastavený na hodnotu 0 a aplikační server není spuštěn, spuštění Web API se nezdaří:
Exception in thread "main" java.lang.RuntimeException: java.lang.RuntimeException: ApiLib library initialization failed (check if application server is running) at apiserver.Main.main(Main.java:78) Caused by: java.lang.RuntimeException: ApiLib library initialization failed (check if application server is running) at apiserver.Main.main(Main.java:54)
Pokud se stále nedaří Web API spustit, zapněte si logování, které by vám mohlo pomoci v odhalení příčiny potíží. Pro účel samotného zprovoznění rozhraní Web API postačuje ponechat výchozí úroveň logování 1 (není nutné v konfiguračním souboru měnit hodnotu parametru level).