Skip to content

Instantly share code, notes, and snippets.

@jasir jasir/notebook.md Secret
Last active Sep 30, 2016

Embed
What would you like to do?
Raml Server - základní použití
site apiNotebookVersion title
1.1.71
Raml Server - základní použití

Základní informace

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.test

Pokud existuje skutečná implementace, jako v tomto případě, zavolá se. Pokud ne, vrátí se example (definovaný v RAML)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.