Skip to content

q2a-suomi/open-api-definition

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

Tässä dokumentissa määritellään, mikä on avoin rajapinta. Täsmällistä määrittelyä tarvitaan esimerkiksi julkisissa tietojärjestelmähankinnoissa, joissa usein vaaditaan avoimia rajapintoja. Ilman määritelmää lähes mitä tahansa rajapintaa saatetaan kutsua avoimeksi, vaikka käytännössä rajapinnan 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 rajapinta, jonka tilaaja voi halutessaan avata.

Määritelmä itsessään ei ota kantaa siihen, missä tapauksissa avoin rajapinta kannattaa tehdä, vaan kertoo millainen on avoin rajapinta, jos sellainen halutaan. On olemassa myös hyviä ja huonoja avoimia rajapintoja aivan kuten on olemassa hyviä ja huonoja suljettuja rajapintoja. Esimerkiksi se, kuinka standardin mukaisia dataformaatteja ja tietorakenteita käytetään, on tärkeä kysymys rajapinnan hyödyllisyyttä arvioitaessa, mutta ei ole osa rajapinnan avoimuuden määritelmää. Kolmas tärkeä huomio on, että rajapinta voi olla avoin, vaikka sen kautta saatava data ei olisi avointa. Tämä määritelmä käsittelee rajapinnan 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 ja Mika Honkanen, Otto Kekäläinen, Martin von Willebrand.

Määritelmän tukijat Seuraavat organisaatiot ja yhteisöt tukevat määritelmää

Keskustelua:

  • Määritelmän kehitysversio on kommentoitavissa osoitteessa http://okf.fi/avoin-rajapinta Keskusteluketju Finnish Open Data Ecosystem -facebookryhmässä ja toinen keskusteluketju JulkICT-strategia linkedin-ryhmässä sekä kolmas 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

Releases

No releases published

Packages

No packages published