跳到主要内容

在公开文档中发布 API 版本

在项目中创建了 API 版本后,即可在「分享文档 -> 发布设置」中,进行 API 版本的发布操作。设置了发布的 API 版本,即可在项目公开地址中查看到所有设置发布的 API 版本内容。

API 版本的发布

在发布版本右侧,点击“添加”按钮,即可在发布版本中添加需要发布的 API 版本。

  • 来源:即在项目中已经建立好的 API 版本,选择后发布版本实际展示的内容即为此 API 版本的内容。
  • 显示版本号:在公开文档中,实际在界面上给文档读者展示的版本号。
  • 运行环境:读者可以在文档中发起调试的环境。
  • Slug:公开项目地址后附带的发布版本唯一标识,例如:https://example.apifox.cn/3-0-0

API 版本的发布

添加完成发布版本后,在列表中即可看到已设置发布的全部版本。可以在列表中进行排序,这个顺序会影响到公开文档页面中读者所看到的发布版本顺序。排在第一位的发布版本为默认版本,不带上 slug 直接访问项目公开地址,会访问到默认版本中。

API 版本的发布

发布版本都设置成功后,将整个项目的发布状态设置为已发布。设置完成后,其他外部用户即可通过 Apifox 项目地址进行访问并查看到文档。文档读者可以在文档页中看到发布版本信息,以及点击切换不同发布版本的 API 内容进行查看。

API 版本的发布