Podcast: Kesytä REST räpellys tyylillä

Updated: Sep 22, 2018

Monologina tehty #APItalousPodcast aiheesta API -tyyliopas. Viime kerralla vieraana oli Jani Karhunen ja puhuttiin kehittäjäkokemuksesta (DX). API -tyyliopas on merkittävässä roolissa kun puhutaan kokonaisten API -perheiden kehittäjäkokemuksesta. API -tyyliopas on keino standardoida APIen suunnittelua, kehittämistä ja käyttäytymistä.


Keskustelu aiheesta Twitterissä hashtag #APItalousPodcast alla. Jakso kuunneltavissa muun muuassa näiden palvelujen kautta:



Mikä API -tyyliopas?


API -tyyliopas on osa APIen hallinnointia (governance), se määrittelee isompaa linjaa APIen kehittämisessä tuoteperheen tai jopa yrityksen laajuisesti. APIt ja alustat kulkevat käsi kädessä ja siksi API -tyyliopas on olennainen osa myös alustojen kehittämistä ja ylläpitoa.

Kyseessä ei siis ole mikään pilipali dokumentti joka kirjoitetaan kerran ja pistetään pöytälaaikkoon niin kuin esimerkiksi monet strategia paperit ja muut vastaavat.


Tyyliopas ei ota kantaa käytettyyn ohjelmointikieleen, vaan antaa reunaehtoja muotoilulle ja toteutukselle vähän samaan tapaan kuin graafiset ohjeistot yrityksen logon käytöstä. Yhtä lailla yleisesti käytetty Open API spesifikaatio luo kehikon API:n kuvaukselle, mutta jättää yksityiskohdat kuten esimerkiksi virheenkäsittely ja parametrien nimeämiskäytännöt soveltajan vastuulle. Tunnetusti paholainen asustaa juuri yksityiskohdissa. API -tyylioppaalla taklaat kyseiset kuopat.

Mitä hyötyä API -tyylioppaasta sitten oikein on?


Tiiviisti sanottuna API-tyylioppaan käytöstä on seurauksena ainakin 6 hyötyä:

  1. Selkeämpi ja nopeammin omaksuttava arkkitehtuuri

  2. Helpommin myytävä ja paremmin myyvä API -perhe

  3. APIen suunnittelu nopeampaa ja vähemmän uudelleenkeksimistä.

  4. APIen toteuttaminen helpompaa ja ylläpito halvempaa.API -tyylioppaalla on työtä nopeuttava, APIn rakennetta ja logiikka yhtenäistävä sekä työmukavuutta lisäävä vaikutus.

  5. APIen testaus nopeutuu ja turhaa työtä poistuu

  6. APIen käyttäjän kokemus paranee ja tämä näkyy lisääntyneenä APIn käyttönä. Sitä vartenhan ne on tehty ja kaupallisesta APIsta alkaa kilistä enemmän tuloa. Tämän nyt luulisi liiketoiminnasta vastaavaa kiinnostavan jos muut edellä mainitut ei oikein uponnut. Kassakoneen kilinää tai sen puuttumista ymmärtää kaikki liiiketoiminnasta vastaavat.

Keskeisimmät käsitellyt asiat

  • Mikä API -tyyliopas on?

  • 6 hyötyä API-tyylioppaasta

Haluatko mukaan podcastiin? Lue lisää apitalisti.fi/podcast

Lue lisää aiheesta API -talous 101 -kirjasta! apitalous101.fi/

©2018 by apitalisti
 

Yhteystiedot

Brändit

Apitalist is registered trademark of APInf Ltd

APIOps is registered trademark of Osaango Ltd and APInf Ltd

Tilaa kirja

API -talous 101 -kirja Alma Talent kaupassa!

Podcast

"Opi tuntemaan API -asiakkaasi" podcast -sarja

Lue lisää!