发布文档站

发布文档站#

文档站可见性设置#

Apifox 版本要求 ≥ 2.7.15

公开发布#

密码保护#

IP 白名单#

邮箱白名单#

自定义登录页#

1

配置说明

进入文档可见性设置页面，选择自定义登录页，填写以下两项内容：

JWT 密钥：用于验证 Token 的签名。必须与你的服务端签发 JWT 时使用的密钥保持一致，该密钥需要你自行生成。

登录地址：用户访问在线文档站时将跳转到此地址。你需要在该地址提供登录页面，并在服务端完成身份验证及 Token 生成。

这个登录地址不是 Apifox 提供的，而是你自己搭建的登录页面。

2

认证机制说明

JWT（JSON Web Token）是一种开放的用户身份令牌标准。你的登录系统需要完成以下流程：

1.

用户访问你通过 Apifox 发布的在线文档站（例如：https://xxxxx.apifox.cn）；

2.

系统自动跳转到你配置的登录页（例如 http://localhost:3000）；

3.

用户输入账号密码并提交；

4.

你的服务端验证用户身份；

5.

登录成功后，生成一个使用你设置的 JWT 密钥（如 pJRdFC3amihQdWbHvUXNZG9WzYdEGHao）签名的 Token；

6.

然后重定向至文档站地址（例如：https://xxxxx.apifox.cn），并通过 auth_token 参数将该 Token 附加在 URL 上，例如：

7.

Apifox 自动校验该 Token，验证通过后，用户可继续访问文档内容。

登录页工作流程，如下图所示：

3

注意事项

JWT 必须由你的服务端生成，签名使用 Apifox 中配置的 JWT 密钥；

JWT 会通过 URL 参数 auth_token 回传到在线文档站；

Apifox 会自动解析并校验 Token；

在线文档站的地址可以是 Apifox 默认发布地址，也可以配置为自定义域名。

4

常见问题

登录页能使用什么技术栈？

没有限制，只要能处理 POST 登录并返回带有 auth_token 的 URL 即可。Node.js、PHP、Python、Go 等均可。

有示例项目吗？

发布范围#

发布多版本的文档站#

发布多个文档站#

永久链接#

其他设置#

个性化设置#

文档内容显示#

高级设置#

文档自定义布局#