发布文档站
发布文档站
文档站可见性设置
Apifox 版本要求 ≥ 2.7.15
公开发布
密码保护
IP 白名单
邮箱白名单
自定义登录页
配置说明
进入文档可见性设置页面,选择自定义登录页,填写以下两项内容:JWT 密钥:用于验证 Token 的签名。必须与你的服务端签发 JWT 时使用的密钥保持一致,该密钥需要你自行生成。 登录地址:用户访问在线文档站时将跳转到此地址。你需要在该地址提供登录页面,并在服务端完成身份验证及 Token 生成。 
这个登录地址不是 Apifox 提供的,而是你自己搭建的登录页面。
认证机制说明
JWT(JSON Web Token)是一种开放的用户身份令牌标准。你的登录系统需要完成以下流程:用户访问你通过 Apifox 发布的在线文档站(例如: 系统自动跳转到你配置的登录页(例如 用户输入账号密码并提交; 你的服务端验证用户身份; 登录成功后,生成一个使用你设置的 JWT 密钥(如 然后重定向至文档站地址(例如: Apifox 自动校验该 Token,验证通过后,用户可继续访问文档内容。 登录页工作流程,如下图所示: 
1.
https://xxxxx.apifox.cn
);2.
http://localhost:3000
);3.
4.
5.
pJRdFC3amihQdWbHvUXNZG9WzYdEGHao
)签名的 Token;6.
https://xxxxx.apifox.cn
),并通过 auth_token
参数将该 Token 附加在 URL 上,例如:
7.
注意事项
auth_token
回传到在线文档站;常见 问题
发布范围
发布多版本的文档站
发布多个文档站
永久链接
ykr5x1s46r.apifox.cn
,你可以手动修改它。所有 Apifox 文档都使用 apifox.cn
域名。