使用自定义域

Postman Basic、Professional 和 Enterprise 计划提供自定义文档域。

您可以为 API 文档使用自定义域。

添加自定义域

在 Postman Web 仪表板中，从团队选项卡中选择团队设置。

编辑团队视图

在“自定义域”部分，您将看到带有验证状态的域列表。选择添加自定义域。

自定义域仪表板

输入您要添加的域的 URL。您的自定义域可以是完整域或子域。例如，您可以使用example.com或api.example.com。

添加自定义域

选择继续以验证域。

验证您的域

添加自定义域时，您将看到一个显示验证域所有权所需的 DNS 记录的模式。要验证您是否控制了您尝试添加的域，您必须将这些提供的令牌作为 DNS 记录添加到您的域以用于 TXT 和 CNAME。

见 TXT 和 CNAME

添加 DNS 记录

对于 DNS 记录，请通过 DNS Web 服务提供商验证所有权。在单独的浏览器选项卡中，转到 DNS 提供商的控制台并添加以下两条新记录。

  1. 用于postman-echo.com验证域所有权的 TXT 记录。该值应与模态中显示的标记相同。将 TXT 记录添加到根域。例如，如果您要添加example.com或api.example.com，请将 TXT 记录添加到example.com。
  2. 的 CNAME 记录docs.postman-echo.com，如模式中所示——这应该是phs.getpostman.com. 将 CNAME 记录添加到与您的公共文档关联的 URL。

要验证域，请选中我已添加 TXT 和 CNAME 记录复选框，然后选择验证域。确认消息应表明该域已通过验证。

验证域

Postman 使用 LetsEncrypt 作为 SSL 证书提供程序来启用在您的域上托管公共文档。如果您的域没有 CAA 记录，LetsEncrypt 会隐式生成证书。如果您的域设置了 CAA 记录，那么 LetsEncrypt 需要明确的 CAA 记录来为该域颁发证书。要启用 LetsEncrypt 颁发此证书，请参阅LetsEncrypt 文档。

如果您不想现在验证域，请选择稍后验证。

您可以通过选择删除自定义域来删除自定义域。

您的 DNS 设置最长可能需要 24 小时才能生效，并且您可能会在此期间收到一条错误消息。要检查状态，您可以访问此网站。

解决 DNS 问题

如果您收到错误消息

RRSet of type CNAME with DNS name <subdomain.domain.com> is not permitted as it conflicts with other records with the same DNS name in zone <domain.com>

添加第一个域时，请注意 CNAME 记录不能与域的任何其他记录共存。您需要将子域的现有记录类型编辑为 CNAME 或添加新的子域。

如果您在添加第二个域时收到相同的消息，请注意，由于 TXT 记录会验证域的所有权，因此该值应与已为根域添加的令牌相同。将 CNAME 记录添加到与您的公共文档关联的 URL，其值应为phs.getpostman.com.

在您的自定义域上发布集合

验证您的域后，您可以使用它来发布您的 API 文档。如果您已经发布了一个集合，您可以对其进行编辑以使用新域。

发布收藏