Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoimen rajapinnan dokumentaatio määritelmässä #33

Open
Mygee opened this issue May 16, 2016 · 1 comment
Open

Avoimen rajapinnan dokumentaatio määritelmässä #33

Mygee opened this issue May 16, 2016 · 1 comment

Comments

@Mygee
Copy link
Contributor

Mygee commented May 16, 2016

Avaan nyt keskustelun määritelmän vaatimasta avoimen rajapinnan dokumentaatiosta.
Yleisesti dokumentaation puute on suurin este rajapintojen hyödyntämiseen. Esimerkiksi koodiesimerkkien puute on todellinen ongelma rajapinnan hyödyntämisessä.

@aapris
Copy link

aapris commented May 16, 2016

Olen samaa mieltä ja jokaisesta rajapinnasta pitäisi olla vähintään komentoriviesimerkkejä (esim. curl- tai httpie-ohjelmalla tai vastaavalla) sekä ainakin 1-2 eri ohjelmointikielellä (esim. java, html+javascript, node.js, python) tehdyt esimerkit, joilla dataa saa pyydettyä rajapinnasta ja käsiteltyä sitä jollain tavoin. Aina parempi, jos rajapinnan tarjoajalla olisi tarjota myös jonkinlainen SDK (softamoduuli/kirjasto), jolla pääsee helposti ja nopeasti käyttämään rajapintaa.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants