Skip to content

okffi/open-api-definition

Repository files navigation

Avoimen ohjelmistorajapinnan määritelmä

Tässä dokumentissa määritellään, mikä on avoin ohjelmistorajapinta. Täsmällistä määrittelyä tarvitaan esimerkiksi julkisissa tietojärjestelmähankinnoissa, joissa usein vaaditaan avoimia ohjelmistorajapintoja. Ilman määritelmää lähes mitä tahansa ohjelmistorajapintaa saatetaan kutsua avoimeksi, vaikka käytännössä ohjelmistorajapinnan dokumentaation saisi vain maksullisena tai pääsyä rajapintaan rajoitettaisiin sopimuksilla. Tilaajan ja toimittajan välisessä sopimuksessa pitää sopia siitä, että toimittajalla on velvollisuus tehdä sellainen ohjelmistorajapinta, jonka tilaaja voi halutessaan avata.

Määritelmä itsessään ei ota kantaa siihen, missä tapauksissa avoin ohjelmistorajapinta kannattaa tehdä, vaan kertoo millainen on avoin ohjelmistorajapinta, jos sellainen halutaan. On olemassa myös hyviä ja huonoja avoimia ohjelmistorajapintoja aivan kuten on olemassa hyviä ja huonoja suljettuja ohjelmistorajapintoja. Esimerkiksi se, kuinka standardin mukaisia dataformaatteja ja tietorakenteita käytetään, on tärkeä kysymys rajapinnan hyödyllisyyttä arvioitaessa, mutta ei ole osa ohjelmistorajapinnan avoimuuden määritelmää. Kolmas tärkeä huomio on, että ohjelmistorajapinta voi olla avoin, vaikka sen kautta saatava data ei olisi avointa. Tämä määritelmä käsittelee ohjelmistorajapinnan avoimuutta, ei sisällön avoimuutta. Mahdollisuuksien mukaan suositus pyritään saamaan mukaan myös JHS-työhön ja julkishallinnon JIT -sopimusehtoihin.

Kirjoittajat

Version 1.0 kirjoittamiseen ja kommentointiin ovat osallistuneet lukuisien anonyymien kommentaattoreiden lisäksi: Antti Poikola, Otso Kivekäs, Joni Kettunen, Teemu Polo, Sami Laine, Jukka Aaltonen, Jarkko Moilanen, Jaakko Korhonen, Mika Honkanen, Otto Kekäläinen ja Martin von Willebrand.

Määritelmän laadittiin avoimessa Google Docsissa, joka löytyy edelleen osoitteesta:

Määritelmän tukijat

Seuraavat organisaatiot ja yhteisöt tukevat määritelmää

Keskustelua

Seuraavissa ryhmissä käytiin keskustelua tästä määritelmästä ennen julkaisua ja sen jälkeen:

  1. Keskusteluketju Finnish Open Data Ecosystem -facebookryhmässä
  2. Keskusteluketju JulkICT-strategia linkedin-ryhmässä
  3. Kokonaisarkitehtuurin osaamisyhteisössä. Otso Kivekäs on myös blogannut aiheesta.

Versio: 1.0 / Julkaistu: 11.10.2014 https://github.com/okffi/open-api-definition/blob/master/fi/avoin-rajapinta.md