Haku

REST API:n optimointi ja päivitys OpenAPI 3:een

QR-koodi

REST API:n optimointi ja päivitys OpenAPI 3:een

REST-arkkitehtuurimallin mukaiset ohjelmointirajapinnat ovat verkkosovellusten ja pilvipalvelujen keskeisiä rakennuspalikoita. Tässä opinnäytetyössä paranneltiin kiinteistöomaisuuden hallintaan tarkoitetun Assetti-pilvipalvelun REST-rajapinnan teknistä toteutusta. Rajapinta oli OpenAPI Specification 2:n mukainen ja prosessin yhtenä toimenpiteenä se päivitettiin vastaamaan OpenAPI:n versiota 3. Parannustoimenpiteiden tavoitteena oli tehdä rajapinnan laajentamisesta helpompaa ohjelmistokehittäjälle.

Työssä tutustuttiin OpenAPI 3:n uusiin ominaisuuksiin ja tärkeimpiin eroihin verrattuna edelliseen versioon. Lisäksi tutkittiin erilaisia työkaluja rajapintakuvauksen muuntamiseen OpenAPI 2:sta 3:een ja ohjelmakoodin automaattiseen tuottamiseen kuvauksen pohjalta. Assetti API optimoitiin helpommin hallittavaksi jakamalla rajapintakuvaus osiin, selkeyttämällä hakemistorakennetta ja poistamalla päällekkäistä koodia. Tämän jälkeen selvitettiin, millaisia muutoksia rajapinnan toteutuksessa tarvittaisiin, jotta se ei enää olisi riippuvainen omista erillisistä tietuerakenteistaan vaan voisi paremmin hyödyntää samaa koodia kuin Assetin muut osat.

Opinnäytetyön tuloksista ilmeni, ettei OpenAPI 3:een päivittäminen yksin tuottanut Assetti API:n tapauksessa merkittäviä hyötyjä. Sen sijaan muut optimointitoimet tekivät rajapinnan ylläpidosta ja laajentamisesta aiempaa helpompaa. Etenkin rajapinnan omien tietuerakenteiden karsiminen nähtiin tärkeänä parannuksena. Opinnäytetyön yhteydessä toteutettiin myös testaustyökalu, jonka avulla rajapinnan toimivuus voitiin varmistaa muutostöiden aikana ja niiden jälkeen.

Tallennettuna: