RAMLspesifikaatioilla

RAMLspesifikaatioilla viittaa RAML:n (RESTful API Modeling Language) käyttämiseen API-deskription laatimiseen. RAML on YAML-pohjainen spesifikaatio, joka mahdollistaa REST-rajapintojen resurssien, operaatioiden, pyyntöjen ja vastausten sekä käytettävien tietotyyppien kuvaamisen sekä dokumentoinnin keinoina. RAML-tiedostoilla on yleensä .raml-pääte.

Keskeiset käsitteet ovat resurssit ja niihin liittyvät polut, sekä kunkin resurssin tukemat HTTP-tekniikat kuten get, post, put ja delete. RAML mahdollistaa myös pyyntö- ja vastausrakenteiden kuvaamisen sekä parametreja, otsikoita ja sisältötyyppejä. Tietotyyppien järjestelmä tukee sekä perus- että mukautettuja tyyppejä, ja se mahdollistaa esimerkkien sekä kuvailujen liittämisen suoraan deskriptioniin. Turvallisuusmalleja, kuten OAuth 2.0 ja API-avaimet, voidaan määritellä RAML-tason turvakoodeina.

Uudelleenkäytön ja koostamisen periaatteet ovat RAML:n vahvuuksia. Mallit, kuten traits (ominaisuudet) ja resource types (resurssityypit), sekä kirjastot (libraries) mahdollistavat yleiskäytäntöjen ja niiden uudelleenkäytön useissa API-tilauksissa. Overlay- ja versionointiominaisuudet tukevat API:n kehityslinjastoa ja eroavaisuuksien hallintaa.

Käyttöönotto ja kehitystyökalut: RAML tukee design-first -työprosesseja, ja siihen liittyvät työkalut kuten API Designer sekä MuleSoftin Anypoint Platform tarjoavat mallintamisen, dokumentoinnin ja testauksen toimintoja. RAML voi olla osa OpenAPI:n kaltaisten standardien ekosysteemiä, ja on olemassa konversiotyökaluja tiedostojen välistä muutosta varten.

RAML-spesifikaatiot ovat olleet käytössä erityisesti enterprise-ympäristöissä, joissa arkkitehtuurin ja sopimusten hallinta on keskeistä. RAML:n aktiivinen käyttö on vähenemässä osittain kilpailun, kuten OpenAPI:n, lisääntyvän suosion myötä, mutta RAML säilyttää roolinsa monissa järjestelmissä ja hankkeissa.