Server dokumentacija - matejbizjak/TrapIT GitHub Wiki

Spodaj so kategorije znotaj backenda, če tista v kateri si delal manjka, dodaj.

---

ROUTES

---

src/routes/

Settings.router

Namen tega router-ja je, da se bilo kateri api-klici, ki getajo ali setajo kakšne informacije o serverju nahajajo oz. gredo skozi ta router. V ta route se posredujejo vsi "/api/settings/" klici.

Trenutni API-klici

• "/settings/basePath" - vrne trenutno nastavljeno statično pot do slik

---

SERVICES

---

src/services/

GlobalVarService

Uporablja se za pridobivanje globalnih spremenljivk, ki so shranjenjene v GlobalServiceVariables.ts . To sem naredil zgolj, zaradi tega, ker na serverside nisem našel druge možnosti, kako bi si različni service-i delili, brali in spreminjali iste spremenljivke (kot naprimer pot_do slik, ki jih lahko spremeni en service, prebere pa drugi). Namen je takšen, da se vse operacije, ki se tičejo globalnih spremenljivk dodajajo v ta service.

• setBasePath(newBasePath: string): void - nastavi globalno spremenljivko basePath (tisto ko mamo za dostop do map slik) na novo, ki je podana funkciji
• getBasePath(): string - funkcija vrne basePath

SettingsService

Uporablja se za funkcije API klicev Settings.router-ja.

• getBasePath(req: Request, res: Response, next: NextFunction) - vrne http reply na api zahtevek (uporablja GlobalVarService)

---

DRUGO

---

/src/global-variables

GlobalServiceVariables

Namen je shranjevanje globalnih spremenljivk, do katerih se dostopa z GlobalVarServicom. Trenutnte globalne spremenljivke so:

• basePath: string - uporabljamo za bazno pot do slik
• databasePath: string mogoče prihodnje v uporabi