| site | apiNotebookVersion | title |
|---|---|---|
1.1.71 |
Raml Server - základní použití |
RAML server je server, který, zpracovává RAML soubory a automaticky vytváří mockovací a testovací prostředí. Pokud existuje v rámci serveru implementace, dané služby, zavolá se tato skutečná služba, pokud ne, vrátí se ukázkový příklad (mock) z implementace.
const server = 'https://gekon-dev.altisima.cz/raml/gekon/v1.0/index.raml';
// pokud potřebujeme debugovat server, můžeme se všemi API requesty
// posílat i hlavičku, která zapne XDebug v PHP
const debug = false;
// vytvoříme API clienta pro prozkoumání API
options = debug ? {headers: {"X-DEBUG-SESSION": 1}} : {}
API.createClient('api', server, options)Nyní již můžeme volat naše API přes objekt api. Jako příklad zvolíme službu api.hello, jejíž primitivní implementace pouze v odpovědi vratí hodnotu poslaného parametru test:
// response = api.hello.get({name: 'vrať tuto hodnotu, prosím...'})
// 'vráceno: ' + response.body.data.test
api.hello.get()
// api.fetchExecutions.post( {name: "Jarda", ico: "123341"} );
response.body.data.testPokud existuje skutečná implementace, jako v tomto případě, zavolá se. Pokud ne, vrátí se example (definovaný v RAML)