Digg gör det enklare att bygga API:er som följer standard

En gemensam standard för effektivare API-utveckling

REST API-profilen är en förvaltningsgemensam specifikation framtagen i samverkan mellan Digg, Bolagsverket, Arbetsförmedlingen, Lantmäteriet och E-hälsomyndigheten. Den ger offentliga aktörer tydliga riktlinjer för hur API:er bör utformas för att möjliggöra effektivt informationsutbyte och interoperabilitet. Genom att kategorisera krav och rekommendationer som SKALL, BÖR och KAN, hjälper REST API-profilen utvecklare att konsekvent leverera API:er av hög kvalitet.

REST API-profilen är en vägledning som syftar till att höja kvaliteten på API:er, främja återanvändning och säkerställa interoperabilitet så att olika digitala tjänster kan samverka effektivt över organisationsgränser.

Förtydliganden i nya versionen av REST API-profilen

Digg har uppdaterat REST API-profilen till version 1.2.0 och skapat ett nytt valideringsverktyg tillgängligt som öppen källkod. Syftet är att ytterligare stärka kvaliteten på API:er och ge offentliga aktörer praktiskt stöd i att implementera profilen.

Uppdateringen av REST API-profilen är en så kallad minor-version, i likhet med den tidigare versionen 1.1.0. I den nya versionen har inga nya större områden tillkommit, utan fokus har legat på att justera och förtydliga befintliga regler.

Syftet med uppdateringen är att ytterligare öka tydligheten i hur kraven ska tolkas och tillämpas. Det underlättar för både nya och erfarna utvecklare att arbeta mer konsekvent med profilen. Uppdateringarna rör flera delar av profilen men utgör inga principiella förändringar i dess struktur.

Nytt verktyg för validering av API:er

För att stödja implementeringen av REST API-profilen har Digg utvecklat och tillgängliggjort ett nytt verktyg som automatiskt kontrollerar koden efter syntaxfel och avvikelser från profilen. Verktyget hjälper utvecklare att snabbt identifiera och åtgärda fel, vilket sparar tid och bidrar till en mer enhetlig API-utveckling.

- Valideringsverktyget ger ett tydligt mervärde för utvecklare. Det gör det möjligt att tidigt fånga syntaxfel och säkerställa att koden följer REST API-profilen. På så vis sparas tid, kodkvaliteten stärks och risken minskar för att felaktig kod går vidare till produktion, säger Fredrik Nordlander, arkitekt på Digg och delaktig i arbetet med att ta fram både profilen och verktyget.

Verktyget är tillgängligt som öppen källkod, vilket innebär att det kan anpassas och vidareutvecklas av användare för att möta specifika behov. Det främjar en gemensam utveckling och möjliggör för organisationer att bidra till förbättringar av verktyget.

• Verktyg för att granska dina OpenAPI-specifikationer mot den nationella REST API-profilen Länk till annan webbplats.

Främjar öppenhet och samverkan

Genom att använda REST API-profilen och det nya valideringsverktyget kan offentliga organisationer säkerställa att deras API:er håller hög kvalitet och är kompatibla med andra system. Detta främjar öppenhet, effektivitet och samverkan inom offentlig sektor, vilket i sin tur stärker den digitala infrastrukturen i Sverige.

Stöd vid implementering

För att underlätta införandet av REST API-profilen har Digg sedan tidigare tagit fram ett Exceldokument som hjälper organisationer att stämma av hur väl deras API:er överensstämmer med profilen. Dokumentet innehåller alla krav med identifikationsnummer, vilket ger en tydlig överblick över implementeringsstatusen och fungerar som ett praktiskt stöd i utvecklingsarbetet. Dokument kan numera genereras fram från det nya verktyget.