REST-rajapinnan suunnittelu ja toteutus OpenAPI specification (OAS 2.0) avulla

Abstract

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.

The thesis studies REST-API design and development on the OpenAPI specification-version 2.0. The thesis presents what different aspects should be considered when API is in the development stage and whether designing should be done before codebase execution. From the OAS 2.0 framework point of view the thesis observes what kind of tools it provides and how API is written on these tools. The thesis also presents alternative frameworks for the API design and development.

The Commissioner on this thesis is Häme University of Applied Sciences Intelligent Services Unit. In practice, the application is based on open source Trafi vehicle data and study example REST API was created based on this.

The study provides the baseline for the future API development on open source vehicle data in wanted direction. Development may for example include new query methods or improved error handling.