Inštalačný manuál pre projekt faersREST - Pacek99/faersREST GitHub Wiki

Inštalačný manuál pre projekt faersREST:

Systémové požiadavky:

• mať v počítači Apache Tomcat server
• mať prístup na internet

Link na Github projektu:

• https://github.com/Pacek99/faersREST

Poznámka: Pre fungovanie tejto časti je potrebné už mať vytvorenú databázu pomocou projektu na import od kolegu G. Mohňanského, link na jeho projekt: https://github.com/mohnanskygabriel/faersDb

Postup:

1.Stiahnúť si tento Maven projekt.

2.V priečinku projektu nájdeme súbor DaoFactory.java, otvoríme ho a prepíšeme konštruktore triedy absolútnu cestu k súboru config.txt za Vašu aktuálnu absolútnu cestu. Následne v priečinku projektu takisto nájdeme aj súbor config.txt, otvoríme ho a v prvom riadku prepíšeme "sql" na svoje vlastné heslo do databázy a uložíme.

3.Otvoriť príkazový riadok v priečinku projektu a použiť príkaz: mvn package

4.V priečinku target nájdite súbor faersREST.war a presuňte ho do webapps priečinku v adresári Vášho Apache Tomcat servera.

5.Otvoriť príkazový riadok v priečinku /bin v adresári Vášho Apache Tomcat servera.

6.V príkazovom riadku zapnúť Apache Tomcat. Napr. vo Windowse príkazom: catalina.bat start

Po vykonaní všetkých bodov si môžeme overiť, či aplikácia funguje tým, že do prehliadača dáme "localhost:8080/faersREST/". Mala by sa načítať stránka s textom "Application faersREST is working!".

Je možné si overiť funkčnosť requestov REST služieb napr.cez Postman-a, alebo aj normálne v prehliadači .

Requesty majú tvar:

poznámka: pri všetkých službách, kde sa vyskytuje NAZOV_LIEKU, NAZOV_UCINNEJ_LATKY alebo NAZOV_VYROBCU , v prípade že daný argument sa skladá z viacerých slov (resp. časti slov) oddelených medzerou tak pri písaní url je potrebné tieto medzery nahradiť "%20"

• pre nájdenie názvu lieku podľa časti názvu lieku: GET http://localhost:8080/faersREST/webapi/brandnames/NAZOV_LIEKU
• pre nájdenie názvu lieku podľa časti názvu účinnej látky lieku: GET http://localhost:8080/faersREST/webapi/substancename/NAZOV_UCINNEJ_LATKY
• pre nájdenie názvu lieku podľa časti názvu výrobcu lieku: GET http://localhost:8080/faersREST/webapi/manufacturername/NAZOV_VYROBCU
• pre filtrovanie liekov zároveň podľa časti názvu lieku, časti názvu účinnej látky lieku a časti názvu výrobcu lieku: GET http://localhost:8080/faersREST/webapi/filter/NAZOV_LIEKU/NAZOV_UCINNEJ_LATKY/NAZOV_VYROBCU pozn.: v prípade, že niektorý z údajov je prázdny, stačí namiesto neho napísať "0" napr.: http://localhost:8080/faersREST/webapi/filter/0/NAZOV_UCINNEJ_LATKY/0
• pre nájdenie vedľajších účinkov lieku podľa názvu lieku: GET http://localhost:8080/faersREST/webapi/sideeffects/NAZOV_LIEKU
• pre nájdenie vedľajších účinkov lieku podľa názvu lieku a od daného dátumu: GET http://localhost:8080/faersREST/webapi/sideeffects/NAZOV_LIEKU/DATUM //datum v tvare YYYYMMDD
• pre overenie či je daný používateľ už zaregistrovaný: GET http://localhost:8080/faersREST/webapi/register/LOGIN pozn.: ak vráti value=1 tak je,zaregistrovaný, ak value=0 tak nie
• pre zaregistrovanie nového používateľa: POST http://localhost:8080/faersREST/webapi/register
  a do tela HTTP metódy dáme:
  { "login": "LOGIN", "mail": "MAIL", "pass": "PASS" }
• pre prihlásenie sa pomocou loginu a hesla: POST http://localhost:8080/faersREST/webapi/login
  a do tela HTTP metódy dáme:
  { "login": "LOGIN", "pass": "PASS" } a výsledok vráti v raw formáte ako string "True" ak je heslo správne a "False" ak je heslo nesprávne
• pre pridanie preferovaného lieku daného používateľa do databázy: PUT http://localhost:8080/faersREST/webapi/preferreddrugs/USER_LOGIN/NAZOV_LIEKU
• pre zmazanie preferovaného lieku daného používateľa z databázy: DELETE http://localhost:8080/faersREST/webapi/preferreddrugs/USER_LOGIN/NAZOV_LIEKU
• pre zobrazenie zoznamu preferovaných liekov daného používateľa z databázy: GET http://localhost:8080/faersREST/webapi/preferreddrugs/USER_LOGIN
• na prekontrolovanie prepojenia medzi REST a DB: GET http://localhost:8080/faersREST/webapi/testmodules vracia True ak spojenie funguje / False ak nie