1 - API-Gateway (Gravitee) yleiskuvaus

Last modified by api_jr@helsinki_fi on 2024/02/07 06:34

Gravitee.io on kevyt avoimeen lähdekoodin perustuva API-gateway alusta. Gravitee tarjoaa työkalut API:ien julkaisuun ja käyttöön. Tässä ohjeessa kuvataan tekniseen alustaan liittyvää ohjeistusta, jotka on hyvä lukea läpi ennen alustan käyttöä.

1 Yleisesti

Helsingin yliopisto on laatinut API-hallintamallin, jossa linjataan, miten mm. API:n julkaisussa on syytä huomioida. Mikäli et ole vielä tutustunut API-hallintamalliin, voit lukea sen täältä. Jos haluat tutustua vain nopeasti miten API saadaan julkaistua tutustu tällä sivulla julkaistuihin ohjeisiin.

2 API-gateway alustan käyttötarkoitus

API-gateway alusta mahdollistaa mm.

  • Rajapintojen (API) julkaisemisen muiden sovellusten ja integraatioiden käytettäväksi.
  • Julkaisun yhteydessä voidaan käyttöä rajoittaa API:n suunnitelman (API-plan) avulla. Näitä voi olla mm.
    • Kutsujen määrä määritellyn ajan sisällä (kutsurajoitukset)
    • Kutsujen autentikointi
  • Rajapintojen kutsumisen/käyttämisen API-gatewayn julkaiseman osoitteen kautta sovelluksittain
  • Rajapintojen käytön monitoroinnin ja valvonnan
  • Rajapintakatalogin
  • Rajapintojen versioinnin

Alustan tarkoituksena on helpottaa rajapintojen julkaisua ja uudelleenkäyttöä. Tämän lisäksi alustan avulla pyritään saamaan parempaa rajapintojen hallittavuutta, jota tuetaan API-hallintamallin menettelytapojen mukaisesti. 

3 Käsitteet

API-Gateway alustassa (Gravitee) on käytössä käsitteitä, jotka on hyvä tietää, mikäli alustaa käyttää. Alla on avattu yleisimmät alustassa käytetyt käsitteet

Käsite

Selite

Plan (suunnitelma)

Rajapinnan julkaisun yhteydessä laaditaan API:lle yksi tai useampi API-suunnitelma, jossa kuvataan mm. tapa tunnistautua sekä API:n liittyvät rajoitukset. ks. kuva

Application (sovellus)

Jotta rajapintoja voi uudelleenkäyttää, tulee API-gatewaylle luoda/rekisteröidä Application eli sovellus, jossa kuvataan sovellus, joka rajapintaa käyttää. Kun API:n käyttöä monitoroidaan ja valvotaan, tehdään tätä nimenomaan sovellusten osalta.

Subscribe (tilaus)

Rajapinnan uudelleenkäyttö edellyttää valitun rajapinnan tilausta (Subscribe). Tilauksen yhteydessä valitaan suunnitelma (Plan), joita julkaisija on rajapinnasta antanut valittavaksi. Tilaus edellyttää aina, että tilaaja on ennen tilausta luonut sovelluksen (Application), jolle tilaus tehdään. ks. kuva 







Parasta ennen: 09.06.2021

Vaikeustaso

Tekninen:

Hallinnollinen:  

Koordinointi:  

Kalenteriaika:  


Vastuunjako

Hallintamallin ja käyttöohjeet

tike-ohjelmistotuotanto@helsinki.fi

API-gateway (Gravitee ylläpito)

tike-integraatiopalvelu@helsinki.fi

Slack helsinki.fi

#api-management


Yhteystietoja

tike-ohjelmistotuotanto@helsinki.fi


Referenssitoteutuksia


Sivun sisällysluettelo


Alasivut