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

Hapi.js Documentation generator for REST API Servers

本文关键字：文档 js Hapi REST API 服务器 用于      更新时间：2023-09-26

我正在寻找一个工具，生成静态文档的Hapi.js路由，但不创建依赖于API服务器。

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

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

  • 必须定义一个视图引擎
  • 必须禁用我的api服务器的最小选项
  • 必须定义一个/documentation路由(我知道我可以改变，但问题仍然存在)

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

谢谢!

首先，lout模块被hapijs正式支持，并且没有被弃用。它提供了另一种昂首阔步的选择。但是它不能解决你的问题，因为它不能生成静态的html/css。

现在是解决方案:我会添加happy -swagger，但只在这样的开发中(这样您就可以在阶段/生产中保持服务器轻量级)…

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

…然后使用bootprint-swagger或类似的东西生成静态HTML，您可以在您选择的web服务器上提供。

相关文章：