Teknisk billag for API - eksempel og råd

[livar.bergheim]

Har du tips på gode eksempel på teknisk billag som skildrar korleis eit API skal vere og krav rundt dette?
Vi fekk ei henvending frå ei offentleg verksemd. Dei lurer på eksempel på teknisk billag til ei tenesteavtale. Ønskjer konkrete eksempel på teknisk billag eller moment å ha med i tenesteavtalen, standardar å bruke og liknande.

Saken er at fleire verksemder er pliktige å tilby API til denne offentlege verksemda.
Tenker dette er nyttig for fleire verksemder som skal stille krav til API og dataformat, enten det er i tenesteavtale eller i anskaffelser.

Maskinelt beskrivne forretningsreglar
I tenesteavtalen er det også fleire forretningsreglar som må følgjast. Til dømes at dersom ein gir inn ein viss verdi på eit felt til API-et, så skal svar frå API-et inkludere ein verdi som er høgare. Er det nokon som har løyst dette på gode måtar? Tenker på maskinlesbare definisjonar av forretningsreglane, som kan gjere det enklare å teste at API-et.