Ny funktionalitet för att utforska API:er24 nov 2021

Ny funktionalitet för att utforska API:er

Utvecklingen av nya digitala lösningar bygger till stor del på att det finns väldokumenterade och tillgängliga gränssnitt för utbyte av data, så kallade API:er. Sedan tidigare finns möjlighet att söka efter API:er på Sveriges dataportal (dataportal.se). DIGG lanserar nu en ny funktionalitet för utvecklare som på ett enkelt sätt vill utforska dessa gränssnitt närmare.

Enklare utforskning av API:er

Sveriges dataportal har en ny funktion för att enkelt utforska ett API. Den nya funktionaliteten stödjer gränssnitt som är beskrivna med OpenAPI-specifikationer (tidigare känd som Swagger), en slags öppen källkodsram för verktyg som använder API:er. Både utvecklingsteam hos utgivare av API:er och slutanvändare kan nu visualisera och interagera med dessa gränssnitt, utan att någon implementering behöver finnas på plats.

Så här använder du den nya funktionen

Funktionaliteten är tillgänglig för alla som söker data på Sveriges dataportal. När ett API har stöd för utforskning på Sveriges dataportal visas knappen ”Utforska API”. I utforskarläget kan du då direkt göra anrop till och utforska API:et. Ibland behöver vissa API:er låsas upp med en API-nyckel som tillhandahålls genom dess utgivare.

Idag stödjer ett urval av API:erna på dataportalen denna funktionalitet. Förhoppningen är att fler utgivare ska inspireras och uppmuntras till att dela gränssnitt med möjlighet till rikare utforskning.

Exempel ny ingång för att utforska API

Exempel på den nya ingången för funktionen ”Utforska API”.

Så här slår du på funktionen för din organisations API:er

Om din organisation idag delar API:er via Sveriges dataportal, som stödjer och är beskrivna med OpenAPI-specifikationen, kan du enkelt slå på funktionen. Det gör du genom att lägga till en länk till OpenAPI-filen (JSON/YAML) direkt i er metadata under fältet ”Länkade scheman” på distributionsnivå. Inom ett dygn genererar Sveriges dataportal automatiskt upp den nya funktionen för ”Utforska API” med dokumentation och relaterade resurser i gränssnittet.

Del av en större satsning

Initiativet är en del av det arbete som pågår inom ramen för regeringens datastrategi. DIGG har uppdraget att främja offentliga aktörers förmåga att dela data och API:er på ett strukturerat sätt. Sveriges dataportal är en central och nationell resurs för datadelning och digital innovation.

Sedan tidigare har DIGG fastställt nationella principer för att tillgängliggöra information. Dessa beskriver att information som tillgängliggörs ska dokumenteras och beskrivas så att den är lätt att upptäcka, förstå och användas av både människor och maskiner, samt vara sökbar på dataportal.se.

Exempel på API:er med OpenAPI-specifikationen

Taxonomi API från Arbetsförmedlingens

Covid-19-vaccinationstider från Västra Götalandsregionen

Luftkvalitet API från Göteborgs stad

Mer information

Sök data och API:er på Sveriges dataportal

Nu finns API:er på Sveriges dataportal

Regeringens datastrategi

Nationella principer för att tillgängliggöra information