npm 包 @leisurelink/hapi-swaggered-ui 使用教程

阅读时长 3 分钟读完

介绍

@leisurelink/hapi-swaggered-ui 是基于 hapi-swaggered 的 Swagger UI 3.x 集成插件,它提供了一种简单的方法,将自动化生成的 Swagger UI 集成到 hapi 中。

安装

安装 @leisurelink/hapi-swaggered-ui 非常便捷,在项目中使用 npm install 进行安装即可,安装命令如下:

配置

在服务器创建时通过 @leisurelink/hapi-swaggered-ui 注册插件,详细的配置项可以参考插件官方文档。

-- -------------------- ---- -------
----- ------ - --- --------------
------------------- ----- ---- ---

----- -------------- - -
    ----- -
        ------ ---- ---------------
        -------- -------------
    --
    ------------------ -----------------
    ---------------- -----------
    -------- -------- --------
--

----- ------- - -
    ------------------
    -----------------
    -
        --------- ---------------------------------------
        -------- --------------
    --
    -
        --------- ------------------------------------------
        -------- -
            ------ ---- ---------------
            ----- -----------------
            ---------------- -------------------------------
            --------------- ------------------------------
            ----- -----
        -
    -
--

------------------------ --------------- -
    -- ------- -
        --------------------- -- ---- - --------- -------
    -
    ----------------------- -
        ------------------- ------- --- - - -----------------
    ---
---

使用

当插件被成功注册后,可以通过以下方式访问 Swagger UI:

这里的 <port>,就是应用启动时所配置的端口,在上面的示例中是 3000<path>,就是在注册插件时所指定的 path,在上面的示例中是 'documentation'

当你访问上面的地址时,Swagger UI 会展示你的 API 文档信息。

总结

@leisurelink/hapi-swaggered-ui 是一款非常适合 hapi 框架使用的 Swagger UI 3.x 集成插件,它的安装和配置都非常简单明了,使用起来也非常方便。希望本文对你有所帮助。完整的示例代码可以在GitHub上查看,点击这里

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066bc7967216659e244501

纠错
反馈