Nasjonal vegdatabank (NVDB) er en database med informasjon om statlige, kommunale, private, fylkes- og skogsbilveger, levert av Statens vegvesen.

Her finner du kode og eksempler for bruk av verktøy som openapi-generator til å generere modeller fra NVDBs APIer.

• LES Områder v4: https://nvdbapiles.atlas.vegvesen.no/api-docs/omrader
• LES Vegobjekter v4: https://nvdbapiles.atlas.vegvesen.no/api-docs/vegobjekter
• LES Vegnett v4: https://nvdbapiles.atlas.vegvesen.no/api-docs/vegnett
• NVDB Datakatalog v1: https://nvdbapiles.atlas.vegvesen.no/api-docs/datakatalog

Du trenger en nyere Node-versjon (20+) og NPM tilgjengelig i PATH. Du kan følge Getting Started, eller installere med NPM:

npm install @openapitools/openapi-generator-cli -g

For å generere f.eks. en ferdig Kotlin-klient mot vår datakatalog, med RestClient og Jackson-serialisering, kall dette:

openapi-generator-cli generate --input-spec https://nvdbapiles.atlas.vegvesen.no/api-docs/datakatalog \
  --generator-name kotlin \
  --output nvdb-datakatalog \
  --global-property models,apis,modelDocs=false \
  --library jvm-spring-restclient \
  --additional-properties useSpringBoot3=true,serializationLibrary=jackson,packageName=no.vegvesen.nvdb.datakatalog,sourceFolder=src/main/kotlin

Hvis du heller ønsker en full Kotlin-implementasjon med kotlinx.serialization, kall dette:

openapi-generator-cli generate --input-spec https://nvdbapiles.atlas.vegvesen.no/api-docs/datakatalog \
  --generator-name kotlin \
  --output nvdb-datakatalog \
  --global-property models,apis,modelDocs=false \
  --library multiplatform \
  --additional-properties dateLibrary=kotlinx-datetime,packageName=no.vegevesen.nvdb.datakatalog,sourceFolder=src/main/kotlin

For å bare generere modeller, med f.eks. Jackson serialisering, kall dette:

openapi-generator-cli generate --input-spec https://nvdbapiles.atlas.vegvesen.no/api-docs/datakatalog \
  --generator-name kotlin \
  --output nvdb-datakatalog \
  --global-property models,modelDocs=false \
  --additional-properties serializationLibrary=jackson,packageName=no.vegevesen.nvdb.datakatalog,sourceFolder=src/main/kotlin

Det kan være nyttig å kjenne til alle parametre som kan sendes med som --global-property, her er en oversikt.

I tillegg kan man se alle generatorene her, med hver sine konfigurasjoner som kan sendes med som --additional-properties.

Hvis man foretrekker å definere konfigurasjonen i en fil, kan man bruke openapitools.json. Denne genereres første gang man kjører openapi-generator-cli, og kan utvides med faste konfigurasjoner for flere OpenAPI-samlinger.

Vi anbefaler å initialisere en package.json og legge inn @openapitools/openapi-generator-cli, da vil man få bedre skjemastøtte når man redigerer openapitools.json:

{
  "private": true,
  "scripts": {
    "generate:datakatalog": "rm -rf datakatalog openapi-generator-cli generate --generator-key datakatalog"
  },
  "dependencies": {
    "@openapitools/openapi-generator-cli": "^2.9.0"
  }
}

Her er et eksempel på openapitools.json:

{
  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
  "spaces": 2,
  "generator-cli": {
    "version": "7.3.0",
    "generators": {
      "datakatalog": {
        "inputSpec": "https://nvdbapiles.atlas.vegvesen.no/api-docs/datakatalog",
        "output": "datakatalog",
        "generatorName": "kotlin",
        "library": "multiplatform",
        "apiPackage": "no.vegvesen.nvdb.datakatalog.api",
        "modelPackage": "no.vegvesen.nvdb.datakatalog.model",
        "globalProperty": "models,apis,modelDocs=false,modelTests=false,apiTests=false",
        "additionalProperties": {
          "dateLibrary": "kotlinx-datetime",
          "sourceFolder": "src/main/kotlin"
        }
      }
    }
  }
}

For å generere koden kjører man så:

npm run generate:datakatalog

Se også package.json og openapitools.json i dette repoet for flere eksempler.

• Java-klient for datakatalogen, med Spring Reactive WebClient og Jackson
• Kotlin-klient for datakatalogen, med Ktor HttpClient og kotlinx.serialization
• TypeScript-klient for datakatalogen, med fetch
• Kotlin-klient for vegnett-APIet, med Ktor HttpClient og kotlinx.serialization

Støtten for TypeScript i openapi-generator er noe grunnleggende. Dersom man ønsker mer avansert funksjonalitet, som generering av Zod-skjemaer eller TanStack Query-hooks, kan man ta i bruk Kubb.

I dette repoet finnes et eksempel som genererer ferdige hooks med TanStack Query for React, inkludert fulle Zod-skjema for validering.

Se package.json for installerte pakker (alle som starter med @kubb), og kubb.config.ts for oppsettet. Generert kode finnes for datakatalogen og vegobjekter fra NVDB LES API v4.