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

时间:2015-06-03 16:39:13

标签: javascript node.js swagger swagger-ui hapijs

我一直在寻找为Hapi.js路由生成静态文档的工具,但不会为API服务器创建依赖项。

所以我只是想象一个cli工具,我可以将server.js作为参数传递,并通过解析我的路径定义来创建API文档。

hapi-swagger个模块失败,因为它会为我的服务器创建以下依赖项;

  • 必须定义视图引擎
  • 必须禁用我的api服务器的最小选项
  • 必须定义/文档路由(我知道我可以更改它,但问题仍然存在)

如果此类工具不存在,创建swagger ui静态文件文档的最佳替代方法是什么?

谢谢!

1 个答案:

答案 0 :(得分:0)

首先,lout模块由hapijs正式支持,不会弃用。它提供了一种替代招摇的方式。但它不能解决您的问题,因为它不会生成静态html / css。

现在解决方案:我会添加hapi-swagger,但仅限于此类开发(因此您可以在登台/制作中保持服务器的轻量级)......

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

...然后使用bootprint-swagger或类似内容生成静态html,您可以在自己选择的网络服务器上投放。

希望这有帮助。