OpenAPI 2.0 mukainen dokumentointi olemassa olevalle REST-rajapinnalle
Tuovinen, Santtu (2018)
Hämeen ammattikorkeakoulu
2018
All rights reserved
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-201805229527
https://urn.fi/URN:NBN:fi:amk-201805229527
Tiivistelmä
Opinnäytetyön tarkoitus on toimia oppaana, kuinka jo olemassa olevalle REST-rajapinnalle saadaan luotua OpenAPI 2.0 mukainen dokumentointi. Työn alussa tutustutaan OAS 2.0 kehikkoon, sen tarjoamiin työkaluihin se-kä syntaksiin.
Työn tilaaja oli Sovelluskontti Oy. Opinnäytetyön käytännön osuudessa luotiin yrityksen asiakkaan rajapintaan OpenApi 2.0 mukainen dokumen-tointi. Rajapinnan laajuuden vuoksi valittiin endpointeista kolme, joista yhtä käytetään esimerkkinä.
Opinnäytetyö luo pohjan, jonka perusteella voi lähteä luomaan dokumen-tointia olemassa olevalle REST-rajapinnalle.
Työn tilaaja oli Sovelluskontti Oy. Opinnäytetyön käytännön osuudessa luotiin yrityksen asiakkaan rajapintaan OpenApi 2.0 mukainen dokumen-tointi. Rajapinnan laajuuden vuoksi valittiin endpointeista kolme, joista yhtä käytetään esimerkkinä.
Opinnäytetyö luo pohjan, jonka perusteella voi lähteä luomaan dokumen-tointia olemassa olevalle REST-rajapinnalle.