Vad är OpenAPI
Specifikation för att beskriva REST API:er
OpenAPI är en standardspecifikation för att beskriva REST API:er, som möjliggör automatiserad dokumentation och kodgenerering.
OpenAPI-fördelar
- Enhetlig API-beskrivningsstandard
- Autogenererad dokumentation
- Klientkodgenerering
- Validering av förfrågningar och svar
Huvudkomponenter
- Info — API-metadata
- Paths — ändpunkter och operationer
- Components — återanvändbara scheman
- Security — autentiseringsmetoder
- Servers — bas-URL:er
Verktyg
- Swagger UI — interaktiv dokumentation
- Swagger Editor — specifikationsredigerare
- OpenAPI Generator — kodgenerering
- Redoc — alternativ dokumentation