14 Tyyli ennen kaikkea – API Design Guide

Luku 14 Twitter.png

Jarkko Moilanen

API-tyyliopas (API Design Guide) ohjaa APIen kehitystä luomalla edellytykset ylläpidettäville rajapinnoille ja elinkaarelle. Yhtenäinen standardeihin pohjautuva tyyli läpi API-perheen luo ammattimaisen mielikuvan, lisää ennakoitavuutta, säästää kehityskustannuksia, nopeuttaa APIn kehitystä, helpottaa käyttöönottoa ja siten myös lisää APIn käyttöä. Tyyliopas ei ole erillinen saareke, vaan parhaimmillaan osana tiivistä vuorovaikutusta eri osapuolten välillä APIn kehittämisprosessissa.

 

Yhteenveto

  • Yhtenäinen standardeihin pohjautuva tyyli läpi API-perheen luo ammattimaisen mielikuvan, lisää ennakoitavuutta, säästää kehityskustannuksia, nopeuttaa APIn kehitystä, helpottaa käyttöönottoa ja siten myös lisää APIn käyttöä.

  • Tyylioppaan keskeinen tehtävä on standardoida organisaation REST APIen suunnittelua, kehittämistä ja käyttäytymistä riippumatta siitä, ovatko hyödyntäjät sisäisiä tai ulkoisia.

  • Käytä standardeja APIn kuvauksessa ja tietosisällöissä.

  • Käytä ulkopuolisia tahoja APIn muotoilun evaluoinnissa välttääksesi pahimmat virheet ja maksimoidaksesi kehittäjäkokemuksen.

  • Tutustu olemassa oleviin julkisiin API-tyylioppaisiin ja julkaise omasi ennen kuin aloitat laajemman API-tuotannon.

 

Kiinnostuitko?