Creating REST APIs with a code generator

Abstract

The goal of this master’s thesis work was to figure out what a web application programming interface (API) generator would look like in the target company’s working environment and to create a proof-of-concept level solution of a code generator. This is a design science case study into one software company, that already utilizes a code generator in their workflow, and they are interested in adding an API generator component to it. Two artefacts were created for this study, one being a baseline API that uses OData and resembles the desired outcome of the generator and a code generator that creates APIs from JSON parameters, using the baseline version as a template. The study found that generating APIs is a viable way of developing web APIs that suite the target company’s customers’ needs. The results also show that it brings a lot of benefits, including efficiency gains. This is also supported by literature and previous studies.

Tämä diplomityön tavoitteena oli selvittää, miltä web rajapinta (API) koodi generaattori voisi näyttää kohde yrityksen ympäristössä ja kontekstissä, sekä kehittää prototyyppi-tason API koodigeneraattori. Tämän työn tutkimusmenetelmä on suunnittelutiede ja tapaustutkimus yritykseen, joka käyttää jo koodigeneraattoria päivittäisessä kehitysputkessaan ja ovat myös kiinnostuneita lisäämään API generaattori komponentin siihen. Tätä työtä varten kehitettiin kaksi artifaktia, toinen on generaattorin mallina ja lähtökohtana käytettä perus API, joka käyttaa ODataa ja toinen on koodigeneraattori, joka tuottaa API:ä käyttäen JSON muotoisia parametreja. Tutkimus toteaa, että API:en generointi on mahdollista ja kannattavaa kohdeyrityksen asiakkaiden tarpeiden toteuttamiseksi. Tulokset myös osoittavat, että API:en generointi antaa monia hyötyjä, kuten parannuksia tehokkuuteen. Tutkimuksen tuloksia tukee myös aikaisempi kirjallisuus ja tutkimukset.