NextDoc4j 简单认证配置

为您的 API 文档添加轻量密码访问保护，防止未授权人员查看敏感接口资产。支持启动时动态生成 UUID 临时凭据与自定义静态密码。

认证参数速查

简单认证功能统一收敛在 nextdoc4j.auth 命名空间：

参数	类型	默认值	说明
nextdoc4j.auth.enabled	boolean	false	是否开启文档密码拦截认证功能。
nextdoc4j.auth.password	string	自动生成 UUID	访问密码。未配置时系统启动会在控制台输出动态密码。

认证配置模式（两选一）

auth

nextdoc4j:
  auth:
    # 仅开启认证开关，不配置 password
    enabled: true

# 应用启动时会在控制台日志输出：
# [NextDoc4j] Documentation Security Password: 8f4a3e2b-7c1d-4e9f-9a0b-1c2d3e4f5a6b

nextdoc4j:
  auth:
    enabled: true
    # 显式配置团队统一的访问密码
    password: "StarCloud_Doc_2025!"

# 开启密码认证
nextdoc4j.auth.enabled=true

# 自定义访问密码（可选，不填则自动生成 UUID）
nextdoc4j.auth.password=StarCloud_Doc_2025!

认证工作流程与安全机制

1

密码加载/生成

Spring Boot 启动时加载静态配置密码或自动生成高强度的 UUID 临时凭据。

2

访问自动拦截

未登录用户访问 /doc.html 时自动重定向并渲染极简登录弹窗卡片。

3

会话 Token 校验

输入正确密码后，浏览器签发安全 SessionStorage 令牌，免密畅享在线调试。

4

重启主动失效

动态密码随应用重启自动刷新，确保临时授权不会无限期长期滞留。

登录界面视觉展示

NextDoc4j 密码认证安全登录界面

SECURITY AUTH

开启认证拦截后，访问 /doc.html 自动跳转至专属安全登录页，输入访问凭据后进入工作台