REST API服务器的Hapi.js文档生成器

Question

I was looking for a tool that generates static documentation for Hapi.js routes, but doesn't create dependencies to the API server.

So I was just visualising a cli tool where I could pass my server.js as an argument, and would create the API documentation by parsing my route definitions.

hapi-swagger modules fails, as it creates the follwoing dependencies to my server;

• Have to define a view engine
• Have to disable the minimal option of my api servers
• Have to define a /documentation route (I know I can change that, but the issue persists)

If such tool doesn't exists, what is the best alternative to create swagger ui static files documentation?

Thanks!

Answer 1

First the lout module is officially supported by hapijs and is not deprecated. It provides an alternative to swagger. But it does not solve your problem because it does not generate static html/css.

Now to the solution: I would add hapi-swagger but only in development like this (so you keep your server lightweight in staging/production)...

...
if (process.env.NODE_ENV === 'development') {
   //Register inert, vision, hapi-swagger with server.register()
}
...

...then use bootprint-swagger or something similar to generate static html which you can serve on a web server of your choice.

Hope this helps.