13 Aloita kevyesti kokeilemalla

Luku 13 Twitter.png

Mika Honkanen

Tässä luvussa tutustutaan API-kehityksen vaiheisiin. Lisäksi opitaan, miten rajapintakuvauksen avulla voi kokeilla APIa kevyesti ja saada tulevilta käyttäjiltä ja muilta osapuolilta kommentteja ennen kuin riviäkään on koodattu. Tämä on tarpeellista, koska ennen toteutusta on syytä varmistua siitä, että APIa todella tarvitaan ja että se täyttää liiketoimintatarpeet.
 

Yhteenveto

 

  • Aloita rajapintakuvauksesta. tee ”hyödyntäjätutkimus” eli kerää palautteet tulevilta APIn hyödyntäjiltä ennen kuin koodaat riviäkään.

  • Käytä standardeja, kuten Open API -spesifikaatiota APIn kuvaukseen. Näin saat dokumentaation kaupan päälle ja pystyt julkaisemaan APIsi API-hallintavälineeseen.

  • Tietomalleihin (skeemat, esimerkit kutsuista ja palautteista) kannattaa kiinnittää huomiota, ja ne kannatta kuvata osaksi APIn spesifikaatiota (definitions-osa Open API-kuvauksessa)

  • Lisätietoja siitä, miten APIn spesifikaatio kannattaa suunnitella, saat luvusta 14.

  • Arvoa on käsitelty enemmän luvussa 2.

 

Kiinnostuitko?