esi-server v3.0.0

node-esi-server

Edge Side Includes (ESI) html fragment http server

This node server aims at rendering templates with provided data using a template provider and a data provider.

Supported template providers:

• nunjucks

Supported data providers:

• koa-router

Install

npm install --save esi-server

Usage

Using the nunjucks template provider and koa-router data provider

const TemplateProvider = require("esi-server-template-nunjucks"),
    {Server} = require("esi-server"),
    templateProvider = new TemplateProvider(),
    DataProvider = require("esi-server-data-koa-router")
    dataProvider = new DataProvider(),
    router = dataProvider.getRouter();
router.get("/articles/:id", ctx => {
    return new Promise(resolve => {
        resolve(Object.assign(
            {
                title: "My article",
                body: "My body"
            },
            {id: ctx.params.id}
        ));
    });
});
app = new Server({
    templateProvider: templateProvider,
    dataProvider: dataProvider
});
// Listen request from port 3000 TCP port
app.listen(3000);

Sample queries

Each query must have a JSON string object with two properties :

• data property is used as arguments of data provider get function
• tpl property is used as arguments of template provider get function

GET /fragment?{"data":["/articles/1"],"tpl":["article.html",{"titleTag":"h1"}]}

GET /fragment?{"data":["/articles",{"order":"publishedAt","limit":10}],"tpl":["articles.html",{"title":"Last published articles"}]}

GET /fragment?{"tpl":["header.html",{"title":"Last published articles"}]}