APIn uudistaminen RESTin mukaiseksi : APIn päätepisteiden implementointi, dokumentointi ja testaus
Koivisto, Iiris (2023)
2023
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-2023112731920
https://urn.fi/URN:NBN:fi:amk-2023112731920
Tiivistelmä
API eli ohjelmointirajapinta mahdollistaa kommunikoinnin ja datan jakamisen sovelluksien kesken. REST-arkkitehtuurilla luotu rajapinta hyödyntää asiakaskoneen tekemiä kutsuja kutsumaan rajapintaan implementoituja päätepisteitä. Nämä päätepisteet määrittelevät, minkälaisen vastauksen palvelin palauttaa kutsuun.
Työn tavoite oli uudistaa Tehden Oy:n rajapinta RESTin mukaiseksi. Siihen sisällytettiin uuden APIn ensimmäisen version päätepisteiden implementointi, dokumentointi ja testaus. Uudistaminen oli tarpeellista, koska asiakkaat ja integraattorit kokivat vanhan APIn sekavaksi ja sen dokumentaation puutteelliseksi.
Jira-sovellusta käytettiin työn organisoimisessa ja jakamisessa. Implementointi tehtiin PHP-ohjelmointikielellä hyödyntäen vanhan APIn osia. Jokaiselle päätepisteelle luotiin minimodel-funktio, kontrolleri ja automaattitestit. Julkinen dokumentointi tehtiin verkko-osoitteeseen https://apidoc.tehden.com/apidoc/v2308/. Päätepisteet testattiin luoden kutsuja testiympäristöön ja käyden läpi järjestelmällisesti kaikki parametrit ja kentät.
Työlle asetetut tavoitteet saavutettiin. Aikataulun vuoksi päätepisteitä jäi puuttumaan neljä. APIn uudistusprojekti jatkuu opinnäytetyön jälkeen, joten puuttuvat päätepisteet julkaistaan tuotantoon mahdollisimman nopeasti. Projektia jatketaan tämän jälkeen implementoimalla ensimmäisen version ulkopuolelle jääneet päätepisteet.
Työn tavoite oli uudistaa Tehden Oy:n rajapinta RESTin mukaiseksi. Siihen sisällytettiin uuden APIn ensimmäisen version päätepisteiden implementointi, dokumentointi ja testaus. Uudistaminen oli tarpeellista, koska asiakkaat ja integraattorit kokivat vanhan APIn sekavaksi ja sen dokumentaation puutteelliseksi.
Jira-sovellusta käytettiin työn organisoimisessa ja jakamisessa. Implementointi tehtiin PHP-ohjelmointikielellä hyödyntäen vanhan APIn osia. Jokaiselle päätepisteelle luotiin minimodel-funktio, kontrolleri ja automaattitestit. Julkinen dokumentointi tehtiin verkko-osoitteeseen https://apidoc.tehden.com/apidoc/v2308/. Päätepisteet testattiin luoden kutsuja testiympäristöön ja käyden läpi järjestelmällisesti kaikki parametrit ja kentät.
Työlle asetetut tavoitteet saavutettiin. Aikataulun vuoksi päätepisteitä jäi puuttumaan neljä. APIn uudistusprojekti jatkuu opinnäytetyön jälkeen, joten puuttuvat päätepisteet julkaistaan tuotantoon mahdollisimman nopeasti. Projektia jatketaan tämän jälkeen implementoimalla ensimmäisen version ulkopuolelle jääneet päätepisteet.