HapiJS global path prefix

Question

I'm writing an API on HapiJS, and wondering how to get a global prefix. For example, all requests should be made to:

https://api.mysite.com/v0/...

So I'd like to configure v0 as a global prefix. The docs (here) don't seem to mention it -- is there a good way to do this in HapiJS?

Answer 1

Matt Harrisson's answer is the hapi way to do it using plugins.

Alternatively if you don't want to create a plugin just to add a prefix, you can by hand, add the prefix to all your routes.

For instance I went for something like this:

  var PREFIX = '/v0';
  var routes = [/* array with all your root */];

  var prefixize = function (route) {  route.path = PREFIX + route.path;return route; }
  server.route(routes.map(prefixize));

Good point is that with something like this your can perform express-like mounting. ex:

 var prefixize = function (prefix, route) {  route.path = prefix + route.path;return route; }

server.route(adminRoutes.map(prefixize.bind({}, "/admin"))); //currying.
server.route(apiRoutes.map(prefixize.bind({}, "/api")));

Answer 2

If you put your API routing logic inside a Hapi plugin, say ./api.js:

exports.register = function (server, options, next) {

    server.route({
        method: 'GET',
        path: '/hello',
        handler: function (request, reply) {
            reply('World');
        }
    });

    next();

};

exports.register.attributes = {
    name: 'api',
    version: '0.0.0'
};

You register the plugin with a server and pass an optional route prefix, which will be prepended to all your routes inside the plugin:

var Hapi = require('hapi');

var server = new Hapi.Server()
server.connection({
    port: 3000
});

server.register({
    register: require('./api.js')
}, {
    routes: {
        prefix: '/v0'
    }
},
function(err) {

    if (err) {
        throw err;
    }

    server.start(function() {
        console.log('Server running on', server.info.uri)
    })

});

You can verify this works by starting the server and visiting http://localhost:3000/v0/hello.

Answer 3

you can always start your index.js like this

if (!global.PREFIX) {
  global.PREFIX = '/v0';
}

this way everywhere inside your code you'll have access to PREFIX

that's how you can access to PREFIX

console.log(PREFIX); or var name = PREFIX+ "_somename";

Answer 4

Take a look at hapi-auto-route. This plugin automaticaly register your routes from a directory

// Directory structure
// 
// node_modules/
// routes/
//  home.js
// server.js
// package.json

// routes/home.js
'use strict';

module.exports = {
    method: 'GET',
    path: '/',
    handler: (request, h) => 'Hello';
}

// server.js
'use strict';

const Hapi = require('hapi');

const server = Hapi.Server({
  port: 3000,
  host: 'localhost'
});

const init = async () => {
    await server.register(require('hapi-auto-route'));
    await server.start();
    console.log(`Server is running at: ${server.info.uri}`);
};

process.on('unhandledRejection', (error) => {
  console.log(error);
  process.exit();
});

init()

and add prefix to it:

Answer 5

I was able to get it working for all routes with

var server = new Hapi.Server()
...
server.realm.modifiers.route.prefix = '/v0'
server.route(...)