Mis on OpenAPI
Spetsifikatsioon REST API-de kirjeldamiseks
OpenAPI on standardne spetsifikatsioon REST API-de kirjeldamiseks, võimaldades automatiseeritud dokumentatsiooni ja koodi genereerimist.
OpenAPI eelised
- Ühtne API kirjeldusstandard
- Automaatselt genereeritud dokumentatsioon
- Kliendikoodi genereerimine
- Päringute ja vastuste valideerimine
Põhikomponendid
- Info — API metaandmed
- Paths — lõpp-punktid ja operatsioonid
- Components — taaskasutatavad skeemid
- Security — autentimismeetodid
- Servers — baas-URL-id
Tööriistad
- Swagger UI — interaktiivne dokumentatsioon
- Swagger Editor — spetsifikatsiooni redaktor
- OpenAPI Generator — koodi genereerimine
- Redoc — alternatiivne dokumentatsioon