API-tyylioppaan kehittäminen – Case Tehden Oy
Juvonen, Emilia (2022)
2022
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-2022121530290
https://urn.fi/URN:NBN:fi:amk-2022121530290
Tiivistelmä
Tämä kehittämistyönä toteutettu toiminnallinen opinnäytetyö perustuu Tehden Oy:n toimeksiantoon laatia API-tyyliopas. API (Application Programming Interface) on ohjelmointirajapinta, jonka avulla sovellukset voivat jakaa tietoa, toiminnallisuutta ja resursseja. Ohjelmointirajapinnasta kehitetään seuraavia versioita, jos päätepisteisiin tehdään muutoksia. Versioinnin tarkoituksena on varmistaa sitä vasten toteutettujen integraatioiden toimivuus ohjelmointirajapintaan tehdyistä muutoksista huolimatta. Sillä annetaan integraatioiden kehittäjille aikaa suunnitella ja toteuttaa tarvittavat muutokset ennen uuden API-version käyttöönottoa.
Tyylioppaan tarkoituksena on toimia toimeksiantajan ohjelmointirajapinnan versioinnin kehittämisen tukena antaen reunaehdot REST APIn muotoilulle ja toteutukselle. Se on myös osa ohjelmointirajapinnan hallintaa. Tyylioppaan kehittäminen toteutettiin yhteistoiminnallisen kehittämisen menetelmin toimeksiantajan nykyisen APIn kartoittamisen ja benchmarking-arvioinnin keinoin. Perustana toimi teoriatieto REST-arkkitehtuurin standardeista, joita kohti ohjelmointirajapinnan seuraavaa versiota haluttiin viedä.
Kehittämistyön tuotos oli toimeksiantajan ohjelmointirajapinnan ominaisuudet huomioiden kehitetty API-tyyliopas, joka laadittiin teoriatiedon ja benchmarking-arvioinnin avulla kirjattujen havaintojen perusteella. Tyylioppaan keskeisimmät osa-alueet ovat REST-arkkitehtuurin mukaiset APIn toimintaperiaatteet, valitut päätepisteiden ja parametrien nimeämiskäytännöt, sekä virheviestien rakenteen ja sisällön määrittelyt.
Tyylioppaan kehittäminen edellytti toimeksiantajan ohjelmointirajapinnan kriittistä tarkastelua ja nosti esiin useita kehittämiskohteita seuraavaa API-versioita varten. Laadittu tyyliopas toimii APIn kehittämisen ohjenuorana, jolloin lopputuloksena on yhdenmukainen ohjelmointirajapinta. Versioinnin käyttöönoton yhteydessä tyyliopasta muokataan julkiseen jakoon, jolloin se palvelee myös integraatioiden kehittäjiä.
Tyylioppaan tarkoituksena on toimia toimeksiantajan ohjelmointirajapinnan versioinnin kehittämisen tukena antaen reunaehdot REST APIn muotoilulle ja toteutukselle. Se on myös osa ohjelmointirajapinnan hallintaa. Tyylioppaan kehittäminen toteutettiin yhteistoiminnallisen kehittämisen menetelmin toimeksiantajan nykyisen APIn kartoittamisen ja benchmarking-arvioinnin keinoin. Perustana toimi teoriatieto REST-arkkitehtuurin standardeista, joita kohti ohjelmointirajapinnan seuraavaa versiota haluttiin viedä.
Kehittämistyön tuotos oli toimeksiantajan ohjelmointirajapinnan ominaisuudet huomioiden kehitetty API-tyyliopas, joka laadittiin teoriatiedon ja benchmarking-arvioinnin avulla kirjattujen havaintojen perusteella. Tyylioppaan keskeisimmät osa-alueet ovat REST-arkkitehtuurin mukaiset APIn toimintaperiaatteet, valitut päätepisteiden ja parametrien nimeämiskäytännöt, sekä virheviestien rakenteen ja sisällön määrittelyt.
Tyylioppaan kehittäminen edellytti toimeksiantajan ohjelmointirajapinnan kriittistä tarkastelua ja nosti esiin useita kehittämiskohteita seuraavaa API-versioita varten. Laadittu tyyliopas toimii APIn kehittämisen ohjenuorana, jolloin lopputuloksena on yhdenmukainen ohjelmointirajapinta. Versioinnin käyttöönoton yhteydessä tyyliopasta muokataan julkiseen jakoon, jolloin se palvelee myös integraatioiden kehittäjiä.