Nettiauton REST-rajapinnan dokumentointi
Sihvo, Jarno (2016)
Sihvo, Jarno
Metropolia Ammattikorkeakoulu
2016
All rights reserved
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2016111416144
https://urn.fi/URN:NBN:fi:amk-2016111416144
Tiivistelmä
Nykyajan sovellukset käyttävät usein rajapintoja laitteiden väliseen kommunikointiin ja tiedonvälitykseen. Tässä työssä käydään läpi sovellusten välisiä rajapintoja yleisesti, miten ja missä niitä käytetään, sekä esitellään erilaisia mahdollisia yritysten rajapintastrategioita. Yrityksillä voi olla erilaisia lähtökohtia rajapintojen rakentamiseen. Niistä voidaan esimerkiksi tehdä julkisia kaikkien käytettäväksi tai rajoitettuja kumppaniyritysten käytettäväksi.
Työssä esitellään lyhyesti REST-rajapintamallia, joka on yleistyvä, kevyt rajapintojen arkki-tehtuurimalli. REST-rajapinnoista tutustutaan Twitterin REST API:in ja testataan sen tarjoamaa rajapinnan interaktiivista testaustyökalua.
Käytännön osuutena työssä dokumentoidaan Nettiauton.comin uutta REST-rajapintaa Swagger-kehystä hyödyntäen. Lopputuloksena on valmis interaktiivinen dokumentaatio, josta selviää rajapinnan resurssit ja käyttömahdollisuudet. Tätä dokumentaatiota hyödyntävät rajapinnan mahdolliset käyttöönottajat.
Työssä esitellään lyhyesti REST-rajapintamallia, joka on yleistyvä, kevyt rajapintojen arkki-tehtuurimalli. REST-rajapinnoista tutustutaan Twitterin REST API:in ja testataan sen tarjoamaa rajapinnan interaktiivista testaustyökalua.
Käytännön osuutena työssä dokumentoidaan Nettiauton.comin uutta REST-rajapintaa Swagger-kehystä hyödyntäen. Lopputuloksena on valmis interaktiivinen dokumentaatio, josta selviää rajapinnan resurssit ja käyttömahdollisuudet. Tätä dokumentaatiota hyödyntävät rajapinnan mahdolliset käyttöönottajat.