API pro interní poskytování dat

LRA API

API je rozdělena na dvě části: Ruian a Organizace. Obě částí obsahují endpointy pro vyhledávání a endpointy pro filtraci, které vyhodí error, když není žádná organizace nalezena.

• Ruian -- poskytuje informace z view AdresniMistaFull a ParcelyFull
• Organizace -- poskytuje informace z view organizations_view

Poznámky k Manticore

• 2x IČO v configu, první v configu kvůli indexaci a druhý kvůli vyhledávání
• to samé u adres, 2-krát KodAdresniMisto

Pro lokální vývoj je potřeba vytvořit manticore.conf. Po vyplnění .env souboru použijte příkazy:

export $(grep -v '^#' .env | xargs) && env

pro export proměnných a

envsubst < manticore.conf.example > manticore.conf

Potřebná dokumentace

Ke každému projektu je zapotřebí vytvořit dokumentaci:

1. Komunikační matice
2. High level Design
3. Popis jak danou aplikaci spustit

Bez této dokumentace se aplikace nedostane ani na testovací server! Pokud nevíte jak dané věci vytvořit, tak se poraďte se svým nadřízeným.

Využité technologie

Aplikace je napsaná v python frameworku FastAPI. Data jsou z databáze nahrána do ManticoreSearch, databáze určené k vyhledávání.

Spuštění aplikace

Pro spuštění aplikace je potřeba mít vyplněný .env soubor a manticore.conf (viz Manticore poznámky). Aplikace se spouští přes Docker. Pro lokální vývoj lze aplikaci spustit pomocí docker-compose-local.yml, kde je aplikace spuštěna v reload režimu:

docker compose -f docker-compose-local.yml up --build --watch

Pro produkci:

docker compose up --build