API development and productization: using Service Design and Design Thinking to identify development needs

Abstract

Koska IT-ala kehittyy nopeasti, yritykset joutuvat nopeasti tilanteeseen, jossa käytössä on vanhanaikaisia menetelmiä ja työkaluja. Tämä saattaa vaikuttaa jopa tuotteiden myyntiin, kun asiakkaat ja kehittäjät välttävät vanhentuneita tekniikoita. Tämän opinnäytetyön tavoitteena oli analysoida nykyistä SOAP-pohjaista API:a ja API-dokumentaatiota sekä käyttää erilaisia tutkimusmenetelmiä hankkiakseen tietoa siitä, miten uudet REST API:t tulisi luoda, rakentaa ja dokumentoida. Tutkimuksen tuloksena oli muutospyyntödokumentti, joka ohjaa kehitystiimin työtä.

Tutkimusongelmana opinnäytetyössä määriteltiin, kuinka siirtyä SOAP API:sta REST API:n, ja valittu laadullinen tutkimusmenetelmä oli teemahaastattelut. Palvelumuotoilun työkaluja käytettiin sidosryhmien tarpeiden ja motivaation määrittämiseen. Koska kyseessä oli laadullinen tutkimusprojekti, tehtävään ei muodostettu ennakkoon hypoteesia. Ennemminkin vastaus tutkimuskysymyksiin nousi esiin kerätyn datan analyysin kautta.

Tutkimuksen ensimmäinen vaihe oli kirjallisuuskatsaus, jota seurasivat olemassa olevien parhaiden käytäntöjen dokumenttien tutkiminen ja teemahaastattelut. Kaikkiin tutkimuskysymyksiin löytyi vastaukset. Tutkimuksen tuloksena oli ensimmäinen iteraatio muutospyyntöasiakirjasta. Johtopäätöksenä voidaan todeta, että prosessi itsessään on toistettavissa myös muille yrityksille. Koska kehitystyö tehtiin yhdelle tietylle yritykselle, tulokset riippuvat kyseisen yrityksen ja haastateltujen työntekijöiden kypsyydestä ja vaatimuksista. Jos sama prosessi toistettaisiin toiselle yritykselle, tulokset olisivat täysin erilaiset.

Due to the fast development in IT, enterprises find themselves in a situation where they have old-fashioned methods and tools in use, to the extent that sales are impacted by customers and developers avoiding outdated techniques. The goal of this thesis was to analyze the current SOAP-based API and API documentation and use different research methods to gather knowledge on how new REST APIs should be created, constructed, and documented. The result of this research was a change request document, which will guide development team’s work.

The research problem defined for this thesis was How to change from SOAP to REST APIs, and selected qualitative research method was theme interviews. Service Design Tools were used to define the stakeholders needs and motivations. As this was a qualitative research project, there was no hypothesis formed in advance about the task; rather, the response to the research question emerged through the analysis of the gathered data.

First phase of the research was the literature review, followed by research of existing best practice documents and thematic interviews. The answers to all research questions were found. The result of this research was a first iteration of a change request document. As a conclusion, as this was an iterative design process, it was not possible to evaluate any error percents. The process itself can be repeatable, but as this development was done for one specific company results depend on the maturity and demands on that company and its employees that were interviewed. If this same process would be repeated for other company results would be completely different.