Ordbok API

Prosjektnettstad • Apollo Sandbox

Introduksjon

Velkomen til Ordbok API, nykelen din til enklare tilgang til data frå ordbøkene. Dette API-et er utforma for å forenkle tilgangen til omfattande informasjon frå dei offisielle norske ordbøkene.

Funksjonar

• Slå opp ord, definisjonar og bøyingsformer frå Bokmålsordboka, Nynorskordboka og Norsk Ordbok.
• Søk på tvers av ordbøkene.
• Spør berre etter det du treng med fleksible GraphQL-førespurnadar.

Korleis bruka API-et

Den beste måten å koma i gang med Ordbok API på, er å vitja Apollo Sandbox og sjå gjennom den interaktive dokumentasjonen. Her kan du utforske API-et, prøve ut førespurnadar og sjå korleis dataa er strukturerte.

Starte prosjektet lokalt

Du treng Node.js, Yarn og Docker installert på maskina di for å køyre Ordbok API. Eg tilrår å bruke Volta for å installere Node.js og Yarn. Brukar du Volta, treng du ikkje installere desse manuelt, sidan kodelageret er konfigurert til å bruke bestemde versjonar.

For å starte Ordbok API lokalt, fylg desse trinna:

1. Klon kodelageret: git clone https://github.com/ordbokapi/api.git
2. Installer avhengnadar: yarn
3. Opprett .env og symlenkjer til pakkene: yarn mkenvlink kopierer template.env til .env og opprettar symlenkjer slik at alle pakkene deler same konfigurasjon. Du kan endre portane og passorda i .env om du treng det.
4. Start tenestene med Docker (PostgreSQL og MeiliSearch) og fylle databasen med ordbokdata: yarn services:start
5. Bygg prosjektet: yarn build
6. Start tenaren: yarn start:dev

API-et lyttar på port 3000 som standard. Opne http://localhost:3000/graphql for å koma til Apollo Sandbox.

Fylle databasen med data

Når databasen er tom fyller yarn services:start som standard lokaldata automatisk med siste dagleg snapshot frå Ordbok API.

Vil du overskrive alle dataa i databasen med nyaste snapshot, køyr yarn services:resync.

Note

Vil du slå av automatisk bootstrap heilt, set variabelen til tom verdi og køyr arbeidarprosessen sjølv i eit eige terminalvindauga for å synkronisere frå UiB.

Dette er ikkje tilrådd, sidan det vil taka veldig lang tid å synkronisere dataa, og det rammar tenestene til UiB med mange førespurnader. Gjer dette berre om du veit kva du gjer og har god grunn til det.

Bootstrap-oppsettet brukar ORDBOKAPI_WORKER_IMAGE. Standardverdien peikar til ghcr.io/ordbokapi/worker:latest, men du kan overstyre han i .env om du vil bruke eit anna bilete. Vil du overstyre kjelda, set SNAPSHOT_PUBLIC_MANIFEST_URL til ein annan URL.

Bidrag

For å bidraga til Ordbok API:

1. Fork kodelageret.
2. Gjer endringar i forket ditt.
3. Send ein pull request med endringane dine.

Lisens

Dette prosjektet er lisensiert under GNU Affero General Public License v3.0 eller seinare. Sjå COPYING for meir informasjon.

Tilbakemelding og kontakt

For spørsmål og tilbakemeldingar, tak gjerne kontakt med meg på GitHub.

Kjelder og takk

Tekst og data frå ordbøkene er © Språkrådet og Universitetet i Bergen, henta frå ordbokene.no. Dette prosjektet er eit uavhengig samfunnsprosjekt av Adaline Simonian og har inga tilknyting til Universitetet i Bergen eller Språkrådet.

© 2026 Adaline Simonian