使用自定义域(Domains)
你可以将 已发布的 API 文档 托管在你自己的自定义域上,而不是托管在getpostman.com
. 添加并验证自定义域后,用户可以使用自定义域访问你的 API 文档。
添加自定义域
通过在标题中选择团队,然后选择团队 设置 来访问**团队设置**。
选择自定义域以查看已为你的团队添加的自定义域以及每个域的验证状态。选择域旁边的查看详细信息获取 验证你的域 所需的验证记录。
要添加新域,请选择添加自定义域并输入你的域的 URL。你可以输入主域(如example.com
)或子域(如docs.example.com
)。
选择继续以验证自定义域。
验证你的域
添加自定义域后,Postman 会显示验证域所有权所需的 DNS 记录。要验证你是否控制你尝试添加的域,请复制提供的令牌并使用它们将 TXT 和 CNAME 记录添加到你的域。将 TXT 和 CNAME 记录添加到你的域后,你可以在团队设置中完成验证。
添加 DNS 记录
要将 DNS 记录添加到你的域,请打开另一个浏览器选项卡并登录到你的域注册商或 DNS 提供商。使用 Postman 提供的令牌将 TXT 记录和 CNAME 记录添加到你的域。
TXT 记录- 将新的 TXT 记录添加到你的域。对于Name,输入
@
以将记录添加到根域。对于Value,使用从 Postman 复制的 TXT 令牌字符串。CNAME 记录- 将新的 CNAME 记录添加到你的域。对于Name,输入你要托管公共文档的子域(例如
docs.example.com
)。对于值,输入phs.getpostman.com
。
添加 TXT 和 CNAME 记录的步骤可能因域注册商或 DNS 提供商而异,并且可能看起来与显示的不同。如果你需要更多帮助,请查看提供商的文档。
完成验证
要完成验证,请返回 Postman 中的团队设置。选中 The TXT and CNAME records have been added旁边的复选框,然后选择Verify Domain。Postman 会显示一条消息,确认域已通过验证。
如果你此时不想验证域,请选择稍后验证。要再次复制 TXT 和 CNAME 令牌,请选择域旁边的查看详细信息。要删除自定义域,请选择 域旁边的删除图标。
Postman 使用 Let's Encrypt 作为 SSL 证书提供程序来在你的域上托管公共文档。如果你的域没有 CAA 记录,Let's Encrypt 会隐式生成证书。如果你的域已经有 CAA 记录,那么 Let's Encrypt 需要一个明确的 CAA 记录来为该域颁发证书。要使 Let's Encrypt 能够颁发证书,请参阅 Let's Encrypt 文档 。
新的 DNS 设置最多可能需要 24 小时才能生效。在此之前,你可能会在访问自定义域时收到错误消息。要检查 DNS 更改的状态,请访问 whatsmydns.net 。
排除 DNS 问题
如果你在尝试将 TXT 或 CNAME 记录添加到你的域时收到错误消息,请检查以下要求:
- CNAME 记录不能与同一域的其他记录共存。如果你已有要托管公共文档的子域的记录,则需要将记录类型更改为 CNAME 或添加新的子域。
- 你不能将 CNAME 记录添加到根域。TXT 记录
@
用于验证根域的所有权。相反,将 CNAME 记录添加到你要托管公共文档的子域(例如docs.example.com
)并将值设置为phs.getpostman.com
.
在你的自定义域上发布文档
在你的自定义域通过验证后,你可以使用它来 发布你的 API 文档 。如果你有一个已发布的集合,你可以 编辑发布设置 以使用新域。