Handle multiple co-resident Swaggerized Hapi plugins

[garthk]

I assemble and deploy Hapi apps like I imagine @hueniverse and @unclebob would have them:

• A plugin for each responsibility with a small, cohesive API
• Each plugin in its own module
• A deployment module with package.json to install the right plugins and a manifest.json to configure the Hapi pack

I'd love to take your design-driven approach and hand my teams the Swagger Editor, but swaggerize-hapi presents an obstacle. The API document has to be embedded in the configuration which, for me, is:

• In the deployment module, not the plugin module where the code is
• Committed and published on a different schedule than the plugin module
• Stored in manifest.json, making dropping in a freshly edited API document harder than I'd like

I'm not sure whether this cuts across your architectural grain too much, but it strikes me you could:

• Have Swaggerized Hapi plugins take a server.dependency on swaggerize-hapi
• Have them register their API document via a method you server.expose, leaving it up to them how to load it from code, file, configuration, or external service
• Merge the APIs
• Throw an exception and crash deliberately if the APIs clash, either with each other or with your documentation route
• Register routes with handlers loaded from the plugins' base paths as usual
• Register the documentation route

The registration method could be as simple as:

server.plugins['swaggerize-hapi'].register(basePath, apiDocument)

I regret I might not be able to contribute code because procedures, but I'm getting good at raising specific and actionable bug reports. Would that be enough help?

[tlivings]

Would

the API document has to be embedded in the configuration...

be simply solved by allowing specification of a path instead of an object?

i.e.

server.pack.register({
    plugin: Swaggerize,
    options: {
        api: Path.join(__dirname, './config/pets.json'),
        handlers: Path.join(__dirname, './handlers')
    }
});

[tlivings]

(note: this is now done in alpha.8)

[aredridel]

Can this be closed now?

[tlivings]

No activity. Closing.

[garthk]

I'll check it out next time I throw together a REST API under Hapi. Thanks!