Komponenta je nameščena na spletnem naslovu https://srip.lavbic.net, kjer so na voljo naslednje funkcionalnosti:
- Kreiranje in objava API-ja je proces povezave obstoječe implementacije API-ja v okviru komponente API Manager Publisher z namenom obvladovanja in spremljanja življenjskega cikla razvoja API-ja, dokumentacije, varnosti in naročnin. Možno je tudi opredelitev API-ja neposredno v API Manager Publisher.
- Prijava na API se izvede pred začetkom uporabe API-ja v okviru aplikacije s pomočjo komponente API Manager Store. Naročnina omogoča pridobitev dostopnega žetona, s pomočjo katerega poteka overitev uporabnika oz. aplikacije pri klicu metod API-ja.
- Klic API-ja preko integrirane API konzole, kjer je v okviru komponente API Manager Store vključeno Swagger UI orodje, s pomočjo katerega lahko testiramo poljubne metode objavljenih API-jev.
- Urejanje in uporaba API-jev s pomočjo Swagger orodij, kjer je v okviru komponente API Manager Store vključeno orodje Swagger Editor, s pomočjo katerega lahko dodajamo in urejamo OpenAPI specifikacijo izbranega API-ja.
- Dodajanje API dokumentacije v okviru komponente API Manager Publisher je namenjeno lažjemu razumevanju uporabe funkcionalnosti API-ja ter je na voljo na digitalni tržnici API-jev. Možno je dodati različne vrste dokumentacije in raznih virov, kjer imajo vsi vključeni dokumenti enoličen URL naslov za lažje obvladovanje SEO.
- Obvladovanje življenjskega cikla API-ja, kjer lahko v okviru komponente API Manager Publisher objavimo nov API, ki je na voljo v digitalni tržnici. Neposredno je podprta objava nove verzije API-ja, medtem ko lahko predhodnje verzije postopoma odstranimo iz uporabe, medtem ko še vedno omogočimo omejeno uporabo.
- Onemogočanje prijave na API lahko izvedemo v okviru komponente API Manager Publisher, s čimer lahko vplivamo na njeno uporabo in monetizacijo.
- Objava WebSocket API-ja je podprta v okviru komponente API Manager Publisher in omogoča dvosmerno komunikacijo med odjemacem in strežnikom v okviru ene povezave. Omogoča nam zmanjšanje nepotrebnega omrežnega prometa in je del HTML5 specifikacije.
Pregled funkcionalnosti WSO2 API Manager
Za testiranje komponente WSO2 tehnološke igralnice so na voljo 3 uporabnika z različnimi ravnmi dostopa, in sicer:
- anonimni uporabnik,
- registriran uporabnik,
- uporabniško ime: sripdemo,
- geslo: sripdemo,
- skrbnik,
- uporabniško ime: admin,
- geslo: admin.
Dostop do posameznih funkcionalnostih glede na različne uporabnike je prikazan v naslednji tabeli:
Funkcionalnost | Anonimni uporabnik | Registriran uporabnik | Skrbnik |
---|---|---|---|
Demo REST API | ✅ | ✅ | |
API Manager Publisher za objavo novih storitev v digitalno tržnico. | ✅ | ✅ | |
API Manager Store za pregled in napredno iskanje po objavljenih storitvah ter generiranje ključev za testiranje in neposredno izvajanje znotraj digitalne tržnice. | ✅ | ✅ | ✅ |
Admin Console za urejanje ključnih vsebinskih nastavitev digitalne tržnice. | ✅ | ||
Carbon Management Console za obvladovanje identitet in funkcionalnost nadzorne plošče sistema. | ✅ | ✅ |
Pri pregledu in testiranju objavljenih storitev je v okviru API Manager Store možna registracija novega uporabnika, in sicer je na voljo na https://srip.lavbic.net/store/site/pages/sign-up.jag.
- Demo REST API s področja slovenskih krajev s pripadajočimi poštnimi številkami in GPS koordinatami, ki omogoča iskanje in manipulacijo s podatki ter je na voljo na https://srip.lavbic.net/demo/api.
- Objava novih storitev v digitalno tržnico z orodjem API Manager Publisher, ki je na voljo na https://srip.lavbic.net/publisher.
- Pregled in napredno iskanje po objavljenih storitvah ter generiranje ključev za testiranje in neposredno izvajanje znotraj digitalne tržnice z orodjem API Manager Store, ki je na voljo na https://srip.lavbic.net/store.
- Urejanje ključnih vsebinskih nastavitev digitalne tržnice z orodjem Admin console, ki je na voljo na https://srip.lavbic.net/admin.
- Obvladovanje identitet in nadzorna plošča za skrbnike sistema z orodjem Carbon management console, ki je na voljo na https://srip.lavbic.net/carbon.
Namestitev je možna s pomočjo Docker virtualizacijskega okolja, kjer je, kot prikazuje slika, na voljo več komponent:
- WSO2 API Manager,
- Demo Node.js API strežnik,
- nginx posredniški strežnik in
- Let's Encrypt.
Vse komponente se namesti na en strežnik, kjer treba poskrbeti zgolj za DNS naslova srip.lavbic.net
in srip-api.lavbic.net
(lahko se jih poljubno spremeni) na katerih so na voljo storitve WSO2 API Manager in demo Node.js API strežnika, kot prikazuje slika.
Podrobnosti namestitve in konfiguracije so na voljo v docker-compose.yml
datoteki z referencami na vse odvisne komponente, vključno z izgradnjo demo Node.js API strežnika v datoteki Dockerfile
.
- aplikacijski programski vmesnik (API),
- specifikacija OpenAPI → zaželjeno,
- objektna notacija za JavaScript (JSON) → zaželjeno,
- razširljiv označevalni jezik (XML) → zaželjeno.