Development of robust SDKs for REST APIs in PHP : how to effectively develop, maintain and release REST API SDKs
Shestakov, Yaroslav (2020)
Shestakov, Yaroslav
2020
All rights reserved. This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-202002021920
https://urn.fi/URN:NBN:fi:amk-202002021920
Tiivistelmä
Nykyaikaisessa talouselämässä ohjelmointirajapintojen (API) suosio on noussut sen ansiosta, että ne mahdollistavat digitaalisen ja automatisoidun vuorovaikutuksen organisaatioiden välillä. Usein, kun järjestelmä integroidaan APIn kanssa, kehitetään kaksi osaa: SDK (Software Development Kit) ja yhdistävä koodi. SDK on ohjelmistokehitystyökalujen kokoelma, jonka tavoitteena on yksinkertaistaa kehittäjän työtä APIn kanssa ja tehdä siitä intuitiivisempaa.
Tämä opinnäytetyö tutki, mallinsi ja dokumentoi toimintavarman SDK:n kehitysprosessia PHP-ohjelmointikielellä sekä osoitti, mitä positiivisia vaikutuksia hyvin suunnitellulla ja dokumentoidulla SDK:lla on integraation laatuun, kehitysnopeuteen ja kehittäjäkokemukseen.
Tutkimus toteutettiin kehittäjän näkökulmasta havainnoituna ohjelmistoprojektina, jossa kehitettiin Tampere Journey Planner APIa kattava
SDK. Tutkimuksen teoreettisessa osassa paneuduttiin API-konseptiin, käytettyihin teknologioihin ja mallinnettiin SDK:n rakennetta. Käytännön osuudessa kuvattiin SDK:n kehitystä, dokumentointia, testausta, pakkaamista ja julkaisemista Composer-paketinhallintatyökalun avulla sekä selvitettiin, kuinka SDK:ta on käytetty uudessa projektissa.
Tulokset osoittavat, että teknisten yksityiskohtien sisällyttäminen SDK:hon sekä intuitiivisten abstraktioiden ja funktioiden tarjoaminen yksinkertaistavat integraatioiden kehitysprosesseja ja tekevät niistä siksi nopeampia. Koodin dokumentoinnin ansiosta automaattinen täydennys koodieditorissa on mahdollista, mikä puolestaan auttaa kehittämään integraatiota ja vähentää virheiden määrää. Ohjelmistopakettina julkaiseminen ja versiohallinta mahdollistavat ohjelmiston tehokkaan uudelleenkäyttämisen ja ylläpitämisen
tiimien ja projektien välillä. Lisäksi liiketoiminnan näkökulmasta laadukas SDK voi tehostaa API-palvelun omaksumista markkinoille ja olla tärkeä menestyvän liiketoiminnan osatekijä.
Tämä opinnäytetyö tutki, mallinsi ja dokumentoi toimintavarman SDK:n kehitysprosessia PHP-ohjelmointikielellä sekä osoitti, mitä positiivisia vaikutuksia hyvin suunnitellulla ja dokumentoidulla SDK:lla on integraation laatuun, kehitysnopeuteen ja kehittäjäkokemukseen.
Tutkimus toteutettiin kehittäjän näkökulmasta havainnoituna ohjelmistoprojektina, jossa kehitettiin Tampere Journey Planner APIa kattava
SDK. Tutkimuksen teoreettisessa osassa paneuduttiin API-konseptiin, käytettyihin teknologioihin ja mallinnettiin SDK:n rakennetta. Käytännön osuudessa kuvattiin SDK:n kehitystä, dokumentointia, testausta, pakkaamista ja julkaisemista Composer-paketinhallintatyökalun avulla sekä selvitettiin, kuinka SDK:ta on käytetty uudessa projektissa.
Tulokset osoittavat, että teknisten yksityiskohtien sisällyttäminen SDK:hon sekä intuitiivisten abstraktioiden ja funktioiden tarjoaminen yksinkertaistavat integraatioiden kehitysprosesseja ja tekevät niistä siksi nopeampia. Koodin dokumentoinnin ansiosta automaattinen täydennys koodieditorissa on mahdollista, mikä puolestaan auttaa kehittämään integraatiota ja vähentää virheiden määrää. Ohjelmistopakettina julkaiseminen ja versiohallinta mahdollistavat ohjelmiston tehokkaan uudelleenkäyttämisen ja ylläpitämisen
tiimien ja projektien välillä. Lisäksi liiketoiminnan näkökulmasta laadukas SDK voi tehostaa API-palvelun omaksumista markkinoille ja olla tärkeä menestyvän liiketoiminnan osatekijä.