Fra REST/OpenAPI til FS GraphQL API
Vi har en rekke APIer som tilbyr data fra FS. De fleste av disse vil i sin helhet bli erstattet av FS GraphQL API. Her vil vi legge ut migreringsguider for de forskjellige APIene.
REST/OpenAPI-baserte APIer og GraphQL-apier brukes nokså forskjellig. Når du skal migrere en klient fra ett av våre REST/OpenAPI-baserte APIer til FS GraphQL API, anbefaler vi at du gjør følgende:
- Les dokumentasjonen av GraphQL-APIet
- Få oversikt over hvilke data du trenger å lese og skrive
- Utforsk GraphQL-APIet. Se hvilke data du kan hente, og hvilke mutasjoner som er tilgjengelig.
- Hvis noe mangler eller det er noe du ikke finner, kontakt fs-support@sikt.no. Små tilpasninger i GraphQL-APIet kan vi ofte gjøre raskt.
- Implementer klienten mot GraphQL-APIet
Gradvis overgang
Det er mulig å bruke REST/OpenAPI og GraphQL samtidig. Dette kan være en god strategi for å gradvis migrere klienter fra REST/OpenAPI til GraphQL. I noen tilfeller vil det også være nødvendig, for eksempel hvis enkelte endepunkter blir avviklet før hele behovet ditt er løst i GraphQL-APIet.
Vi legger til rette for gradvis overgang mellom REST/OpenAPI og GraphQL ved å:
- Tilby spørringer og mutasjoner som tilsvarer REST/OpenAPI-endepunkter vi har varslet avvikling av
- Skrive migreringsguider med eksempler på hvordan du kan erstatte bruk av enkeltendepunkter med GraphQL
- Tilby oppslag på IDer fra de gamle APIene i GraphQL-APIet der det er hensiktsmessig
Du kan beholde API-brukeren din
API-brukere som har tilgang til legacy-apiene kan også brukes mot FS GraphQL API. Du bestiller tilgang til FS GraphQL API på vanlig måte. Når du bestiller tilgang til FS GraphQL API, er det viktig at du spesifiserer hvilke data du ønsker tilgang til. Les mer her: Hvordan får jeg tilgang? og Tilgangsstyring med RAS