Lämna synpunkter på nationell REST API-profil 15 dec 2021

Lämna synpunkter på nationell REST API-profil

Just nu utvecklas en rekommenderad nationell REST API-profil för offentliga aktörer i syfte att öka kvaliteten på API:er och dess dokumentation. Profilen kommer att publiceras på en ny undersida till Sveriges dataportal, kallad Utvecklarportalen. Nu vill DIGG inhämta synpunkter från dig som arbetar med utveckling av API:er.

Högre standard och kvalitet

Utvecklingen av API:er är central för att den offentliga förvaltningen ska kunna dela och använda data, främja innovation och skapa samhällsnytta. Användning av den föreslagna profilen syftar till en generellt högre standard och kvalitet på API:er, både på dokumentationen och själva API:et. Det underlättar för både producenter och konsumenter av data. 

Ökad acceptans och användning

Profilen riktar sig främst till API-designers och API-utvecklare som arbetar med framtagande av nya eller ändrar i befintliga, för att t.ex. förbättra funktionalitet, användbarhet, läsbarhet eller säkerhet. Profilen gör det möjligt att bygga REST API:er på ett effektivare sätt utifrån bästa praxis och en uppsättning identifierade SKALL/BÖR/KAN kravformuleringar. Detta förenklar processen och påskyndar både acceptansen och användningen av API:er.

Ett myndighetsgemensamt arbete

REST API-profilen är framtagen av DIGG tillsammans med en arbetsgrupp från Arbetsförmedlingen, Bolagsverket, E-hälsomyndigheten och Lantmäteriet.

Diskutera och ge synpunkter

En central del i utvecklingen är att du som utvecklar API:er, eller på annat sätt stödjer det arbetet, ska kunna ge synpunkter och diskutera den nationella API-profilen. För detta finns följande möjligheter:

  • Använd formuläret nedan för formella synpunkter och förbättringsförslag. Sista svarsdag är 10 februari 2022. Inkomna synpunkter hanteras och bearbetas därefter av DIGG tillsammans med arbetsgruppen kring utvecklingen av REST API profilen.
  • Diskutera på Sveriges dataportals community. Här kan du dela kunskap och ställa frågor till andra utvecklare av API:er och diskutera rekommendationerna och hur dessa kan appliceras. Vänligen notera att DIGG inte kommer ha möjlighet att ta i beaktning eller återkoppla på alla eventuella synpunkter som ges som kommentarer i detta forum.

Fortsatt vidareutveckling

När synpunkter tagits emot och bearbetas, avser DIGG att fastställa rekommendationen för den nationella REST-API-profilen. Preliminärt lanseras den första versionen i mars 2022. Utvecklarportalen med tillhörande rekommendationer och nationella API-profiler kommer löpande att vidareutvecklas, och kan på sikt även komma att utvidgas för andra typer av maskinläsbara gränssnitt.

Länkar