Hva er OpenAPI
Spesifikasjon for å beskrive REST API-er
OpenAPI er en standardspesifikasjon for å beskrive REST API-er, som muliggjør automatisert dokumentasjon og kodegenerering.
OpenAPI-fordeler
- Enhetlig API-beskrivelsesstandard
- Autogenerert dokumentasjon
- Klientkodegenerering
- Validering av forespørsler og svar
Hovedkomponenter
- Info — API-metadata
- Paths — endepunkter og operasjoner
- Components — gjenbrukbare skjemaer
- Security — autentiseringsmetoder
- Servers — basis-URL-er
Verktøy
- Swagger UI — interaktiv dokumentasjon
- Swagger Editor — spesifikasjonsredigerer
- OpenAPI Generator — kodegenerering
- Redoc — alternativ dokumentasjon