RESTtyyppiset

REST-tyyppiset (REST resource types) ovat REST-rajapinnan suunnittelussa käytettyjä resurssityyppejä, joille API määrittelee yhteisen rakenteen ja semantiikan. Jokaiselle tyypille on tyypillistä, minkälaisia resursseja kuuluu samaan ryhmään, millainen URI-muoto ne noudattavat ja millaisia representaatiota (payload) voidaan käyttää. REST-tyyppiset helpottavat sekä API-dokumentointia että koodin generointia tai koodauksen staattista tarkastelua.

Tyypin ominaisuuksiin kuuluu, miten resurssi identifioidaan URI-poluissa, sekä millaisia operaatioita se tukee (esim. GET, POST, PUT, DELETE, PATCH) ja mahdollinen hypermedia-ohjaus (HATEOAS). Representaatioissa käytetään yleisesti standardoituja formaatteja kuten JSON tai XML, ja niissä voi esiintyä sekä attribuutteja että suhteita muihin tyyppeihin. Esimerkiksi käyttäjätyyppinen resurssi voi olla /users/{id}, tilaus-tyyppi /orders/{orderId}, ja ne voivat linkittää toisiinsa tai sisältää sisäisiä kokoelmia.

Käytännössä REST-tyyppiset voivat muodostaa oman hierarkiansa ja relaatiot, kuten kokoelmat (collections) ja yksittäiset resurssit, sekä sub-resurssit (esim. /orders/{orderId}/items). Eri tyypit voivat käyttää eri representaatiomalleja, kuten HAL- tai JSON:API -rakenteita, jotka kuvaavat resurssin välisiä suhteita ja linkkejä. Suunnittelussa kiinnitetään huomiota nimen vakiintumiseen (monikkoa käyttäen), versionointiin, sekä siihen, miten muutokset vaikuttavat olemassa oleviin asiakkaisiin.

REST-tyyppisiä käytetään usein OpenAPI- tai Swagger-dokumentaatiossa, jossa tyypit määritellään osana API:n rajapinnan mallia. Tämä mahdollistaa automaattisen asiakkaan koodin generoinnin sekä paremmat kehitystyökalut. Suomenkielisessä ohjelmistokehityskeskustelussa termi viittaa yleiseen käytäntöön mallintaa API:n resurssityypit ennen yksittäisten resurssien toteuttamista.