Webapi.no – OpenAPI-spesifikasjon

Last ned API-beskrivelsen og generer en ferdig klient i C#, TypeScript eller et annet språk – i stedet for å skrive den for hånd.

Hva er OpenAPI?

OpenAPI (tidligere kjent som Swagger) er en spesifikasjon som brukes til å beskrive, dokumentere og utvikle RESTful API-er. Det er et standardisert format som gjør det lettere for utviklere å bygge, teste og bruke API-er, siden det gir en felles forståelse av hvordan API-et fungerer.

En OpenAPI-fil er vanligvis skrevet i YAML eller JSON, og beskriver blant annet:

  • Endepunkter: hvilke URL-er som er tilgjengelige.
  • Metoder: hvilke HTTP-metoder (GET, POST osv.) hvert endepunkt støtter.
  • Parametere: hvilke data (for eksempel query-parametere) API-et forventer.
  • Respons: hvilken type data og hvilke statuskoder API-et returnerer.

Med OpenAPI kan du generere klientbiblioteker automatisk, slik at du slipper å skrive dem for hånd.

Kom i gang

API-beskrivelsen til webapi.no finner du her:

https://webapi.no/openapi/v1.json

Noen vanlige verktøy for å generere klienter:

Eksempel med Kiota:

kiota generate -l CSharp -d https://webapi.no/openapi/v1.json -c WebapiClient -n Webapi.Client -o ./Client

Se alle endepunktene med eksempler på forsiden.

Kopiert til utklippstavle