Eesolev rakendus on valminud õppeaine "Veebiteenused" raames. Teenus koosneb SOAP ja REST API-st, mis on loodud Java Spring Boot raamistikus. Dokumentatsioonis käsitletakse SOAP ja REST API-sid eraldi moodulitena.
- IDE
- Gradle
- Brauser
- Apache Tomcat
$ git clone https://github.com/kasparkivistik/cyclingresults.git
$ cd cyclingresults
$ gradle genJaxb --genereerib WSDL järgi klassid
$ gradle bootRun
SoapUI-s käivitamiseks
$ localhost:8080/ws/diploma.wsdl
$ kopeerida see SoapUI WSDL aknasse
Projekt on koostatud kasutades Spring Boot raamistikku. WSDL ja POJO on genereeritud XSD dokumendist, kasutades JAXB libraryt ja Gradle'it.
Teenus koosneb kahest API-st. SOAP ja REST.
Teenusel on kaks põhiobjekti: diploma (diplom) ja competitor (võistleja).
Objekt Diplom koosneb järgnevatest elementidest:
- id,
- üritus (event),
- ürituse toimumisaeg (timeOfEvent),
- osaleja aeg (time),
- koht (placement),
- vanuseklass (ageGroup),
- võistleja (competitor)\
Sealhulgas tuleb mainida, et vanuseklass on enumeratsioon, mis koosneb järgnevatest võimalikest valikutest:
- M10
- M12
- M14
- M16
- M18
- U23
- N10
- N12
- N16
- N18
- SEN
- M
- N
Objekt Võistleja koosneb järgnevatest elementidest:
- id,
- nimi (name),
- isikukood (personalCode)
Kõik objektidega tehtavad operatsioonid on kasutatavad nii SOAP kui ka REST APIs. Teenuses kasutataske idemptsuse printsiipi, ehk iga päringuga on kohustuslik anda kaasa API token, ilma milleta päringut ei rahuldata.
Kui üldiselt API token antaks kaasa näiteks autoriseerimisel, on käesolevas projektis see hardcodetud sisse tekstivälja "secrettoken123" nimel.
Kuna mõlemad APId kasutavad sama "andmebaasi", siis on nad seotud ühise repositoryga, mistõttu SOAP service meetodid võtavad sisse sama objekti, mis REST API, aga väljastavad WSDLis määratud Response objekti.
API koosneb kaheksast operatsioonist:
- addCompetitor
- addDiploma
- findAllCompetitors
- findAllDiplomas
- findCompetitorById
- findDiplomaById
- setCompetitorToDiploma
- findAllDiplomasWithCompetitors
- searchCompetitors
- addCompetitor
Teenus lisab võistleja andmebaasi. Teenuse käigus genereeritakse võistlejale automaatselt ID, nime ja isikukoodi peab klient ise määrama. ID on long andmetüüpi, nimi ja isikukood on string andmetüüpi. Muidugi ei saa ära unustada tokenit, mis käib kaasas iga teenusega. Edaspidi ma seda esile tooma ei hakka.
Teenuse väljund tagastab süsteemile uue võistleja ID, nime ja isikukoodi. Täpselt samad andmed, mis süsteemile ka esitati.
- addDiploma
Teenus lisab diplomi andmebaasi. Teenuse käigus genereeritakse diplomile automaatselt ID, võistluse nime, võistleja aja, võistluse toimumise aja, vanuseklassi ja koha peab klient ise seadistama. Võistluse nimi on string andmetüüpi, võistleja aeg ja võistluse toimumise hetk on vastavalt time ja dateTime, vanusegrupp on stringidest koosnev enumeratisioon ja koht on long.
Teenus tagastab sama informatsiooni, mis klient süsteemi lisas, lisaks veel automaatne ID ja olenemata olemasolule võistleja, kellega diplom seotud on.
- findAllCompetitors
Teenus tagastab kõik andmebaasi registreeritud võistlejad. Tagastatakse võistleja ID, nimi ja isikukood (Competitor objekt).
- findAllDiplomas
Teenus tagastab kõik andmebaasi registreeritud diplomid. Tagastatakse Diploma objekt.
- findCompetitorById
Teenus leiab võistleja ID järgi võistleja objekti. Tagastatakse Competitor objekt.
- findDiplomaById
Teenus leiab diplomi ID järgi diplomi objekti. Tagastatakse Diploma objekt.
- setCompetitorToDiploma
Teenus lisab diplomile võistleja. Tagastatakse Diploma objekt, kuhu Competitor objekt juurde lisati.
- findAllDiplomasWithCompetitors
Teenus tagastab kõik diplomid, kuhu on määratud võistleja. Seega tagastatakse Diploma objekt, kus Competitor pole null.
- searchCompetitors
Teenus tagastab kõik võistlejad, mis vastavad päringus edastatud väljade tulemusele. Filtrile.
REST API on dokumenteeritud kasutades Swagger UId.
Swagger on kättesaadav SIIN pärast Spring Booti rakenduse käivitamist.
Samuti on võimalik Swagger UIst näha teenuses kasutatud mudelite disaini (Competitor ja Diploma objekte).
11.05: projekt on veel pooleli. Miskipärast REST service POST meetodid tagastavad null-objekti. Parandan selle esimesel võimalusel ära. Vabandan.
21.05: REST toimib. Väga loll viga.
25.05: Kõik peale setCompetitorToDiploma toimib SOAP poole pealt.
26.05: Meetodit väljakutsudes, palun kontrollige üle, kas järjekord on õige... setCompetitorToDiploma töötab!