什么是 hapi-swagger
hapi-swagger
是一个 npm 包,用于将 swagger 规范集成到 hapi 服务中,可以生成 API 文档,并提供交互式 UI。
安装
--- ------- ------------ ------
集成到 hapi 服务中
---- -------- ----- ---- - ---------------- ----- ----- - ----------------- ----- ------ - ------------------ ----- ----------- - ------------------------ ----- ---- - --------------------- ----- ------ - --- -------------- ------------------- ----- ------------ ----- ---- --- ----- -------------- - - ----- - ------ ----- --- --------------- -------- ------------- -- -- ----------------- ------ ------- - ----------- ------------ ---------- -------------- - -- ----- -- - -- ----- - ----------------- - --- ------------------ -- - -- ----- - ----------------- - ------------------- ------- --- --------------------- ---
配置参数
info
title
:文档标题。version
:文档版本。
pathPrefixSize
- 值为
1-4
。 - 用于将路径的一部分移动到 swagger 的 tag 标签中。
basePath
- 值为字符串。
- 配置请求的 base URL。
jsonUrl
- 值为字符串。
- 指定 swagger 文档 JSON 文件的 URL 地址。
swaggerUI
- 配置 swagger UI 的相关选项。
securityDefinitions
- 对应 security 定义。
securityHandlers
- 对应 security 处理方式。
payloadType
- 配置支持的 payload 类型。
sortTags
- 配置 tag 排序方式。
示例代码
-- ----- ---------- ----- --- - --------------- ----- --------- - --- ----------------- - - - --- -- ----- ---------- -- - --- -- ----- --------- - -- ---------------- - -------- -------- ----- -- - -------------- ------- ------ ----- ----------- -------- --------- ------ -- - ------ ------------------------- -- ------- - ----- -------- ------------ ---- --- --------- ------ -------- --- ------- ----------- - --- -------------- ------- ------ ----- ---------------- -------- --------- ------ -- - ----- ------ - ---------------------------- -- ---- -- ---------------------- -- --------- - ------ --------------------------- --- --------- - ------ -------------- -- ------- - ----- -------- ------------ ---- --- -------- ------ -------- --- ------ -- --- ---- --------- - ------- - --- --------------------------------------------------------- -- --- --- ------ ----- ------------ - - - --- ------- -- --------------------------- - - ----- --------- --
可用以下命令启动该示例:
---- ----------
服务启动后,在浏览器中访问 http://localhost:3000/documentation
可以查看 API 文档。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/57826