README.MD

VulcaiNode

VulcaiNode is JavaScript implementation of vulcain protocol

Configuration

You must set environment variables:

• UPSTREAM
• PORT

Additional settings:

• LOGGER

You can use .env file

Usage

VulcaiNode accept only case-insensitive headers unlike original vulcain implementation:

• preload
• fields

const vulcainode = 'https://ip:port/v1'
const resp = await fetch(vulcainode + '/resource', {
  headers: {
    preload: '/relation1/*/relation2/relation3',
    fields: '/:id,field1,field2/relation2:id,field1/relation3:id'
  },
  credentials: 'same-origin',
})
return await resp.json()

Starting

UPSTREAM=http://your-api:8888/v1 PORT=1234 node index.js

Better to use pm2

Roadmap

• Preload
• Fields
• OpenApi 3 integration
• Tests

License

MIT © Vano Devium