OpenAPIpohjaiset

OpenAPIpohjaiset viittaa ohjelmistokehityksessä käytettyyn lähestymistapaan ja ekosysteemiin, jotka perustuvat OpenAPI-standardiin (aiemmin Swagger). OpenAPI, eli OpenAPI Specification (OAS), kuvaa REST-rajapinnan rakenteen: päätepisteet, HTTP-metodit, pyynnön ja vastauksen rakenteet sekä tietomallit (schemas). OpenAPIpohjaisia ratkaisuja käytetään sekä API:n suunnittelussa että toteutuksessa, dokumentoinnissa ja testauksessa. Käytännön toteutuksissa voidaan noudattaa design-first -lähestymistapaa, jossa sopimus (OpenAPI-dokumentti) luodaan ennen koodia, tai code-first -lähestymistapaa, jossa dokumentaatio syntyy koodista. Dokumentaatio tallennetaan yleensä YAML- tai JSON-muotoisena tiedostona.

Työkalu- ja ekosysteemi OpenAPIpohjaisissa on laaja: OpenAPI Generator ja Swagger Codegen voidaan tuottaa kliendi- ja serverikirjastoja useille kielille ja kehyksille; Swagger UI ja Redoc tarjoavat interaktiivisen, selaimen kautta kokeiltavissa olevan dokumentaation. Validointi- ja testausvaiheessa käytetään spesifikaation validointia, kontraktitestauksia ja mock-palvelimia; Spectral puolestaan auttaa dokumentaation ja määrittelyn laadunvalvonnassa.

Hyödyt: parempi yhteentoimivuus, selkeä API-sopimus, nopeutettu kehitysprosessi sekä mahdollisuus automaattiseen client- ja server-koodin sekä dokumentaation generointiin. OpenAPIpohjaiset ratkaisut ovat yleisiä API-first ja mikropalvelu-arkkitehtuureissa sekä pilvi- ja backend-kehityksessä.