REST-rajapinnan suunnittelu ja toteutus OpenAPI specification (OAS 2.0) avulla
Saarikko, Petteri (2017)
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2017100815835
https://urn.fi/URN:NBN:fi:amk-2017100815835
Tiivistelmä
Opinnäytetyössä tarkastellaan REST-rajapintojen suunnittelua ja toteutusta OpenAPI specification-version 2.0 avulla. Työssä selvitetään mitä seikkoja tulisi huomioida, kun rajapintoja suunnitellaan ja tulisiko suunnittelu tehdä ennen varsinaista toteutusta. OpenAPI specification-version 2.0 osalta tarkastellaan, mitä työkaluja se tarjoaa ja miten rajapintakuvaus luodaan tällä kehikolla. Työssä myös esitellään vaihtoehtoisia työkalukehikkoja rajapintojen suunnittelua varten.
Työn tilaaja oli Hämeen Ammattikorkeakoulun Älykkäät palveluttutkimusyksikkö. Käytännön sovelluksessa käytettiin Trafin julkaisemaa avointa ajoneuvodataa, jonka käyttämistä varten luotiin esimerkki rajapinta REST-periaatteiden mukaisesti.
Opinnäytetyö muodostaa pohjan jonka perusteella voi lähteä laajentamaan avoimen ajoneuvodatan rajapintaa haluttuun suuntaan niin rajapinnan metodien kuin esimerkiksi virheenkäsittelyn osalta.
Työn tilaaja oli Hämeen Ammattikorkeakoulun Älykkäät palveluttutkimusyksikkö. Käytännön sovelluksessa käytettiin Trafin julkaisemaa avointa ajoneuvodataa, jonka käyttämistä varten luotiin esimerkki rajapinta REST-periaatteiden mukaisesti.
Opinnäytetyö muodostaa pohjan jonka perusteella voi lähteä laajentamaan avoimen ajoneuvodatan rajapintaa haluttuun suuntaan niin rajapinnan metodien kuin esimerkiksi virheenkäsittelyn osalta.