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

标签 javascript node.js swagger swagger-ui hapi.js

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

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

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

  • 必须定义一个 View 引擎
  • 必须禁用我的 API 服务器的最小选项
  • 必须定义一个/documentation 路径(我知道我可以更改它,但问题仍然存在)

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

谢谢!

最佳答案

首先,lout 模块受到 hapijs 的正式支持,并且并未弃用。它提供了一种替代 Swagger 的方法。但它并不能解决你的问题,因为它不会生成静态 html/css。

现在解决方案:我会添加 hapi-swagger 但仅在像这样的开发中添加(这样您就可以在登台/生产中保持服务器轻量级)...

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

...然后使用 bootprint-swagger或类似于生成静态 html 的内容,您可以在您选择的 Web 服务器上提供该静态 html。

希望这有帮助。

关于javascript - REST API 服务器的 Hapi.js 文档生成器,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/30625926/

相关文章:

java - Swagger @ApiModelProperty 基于 HTTP 请求的灵活性

node.js - Nodejs 构建 sublime-text2

java - 如何从javadocs生成Swagger UI?

javascript - 导航元素不会延伸到父元素的高度

javascript - 将 GET 参数转发到下一个 URL

javascript - 如何在对象模式下一次性在 Node.js 流中分配 block ?

node.js - 防止 require(...) 在父目录中查找模块

spring-boot - Swagger-UI 在根端点上不显示 SpringBoot 和路径参数

javascript - Jquery ajax onSuccess 事件

javascript - 年龄验证弹出窗口仅显示一次