跳到主要内容

文档左侧目录设置

Apifox 为 API 文档提供了左侧目录设置功能,可以根据你的需要,设置成你想要的样式和布局。

提示

Apifox 版本号需 >=2.6.6 才能进行设置。

设置入口

当你想要特殊设置某个目录样式的时候,在 Apifox 中,点击你选择的目录进行设置。

Apifox 分享分档-分享后的文档配置

目录树展示方式

普通目录: 作为默认选项,目录是以文件夹的形式展示。点击目录时,可以展开/收缩目录。 Apifox 分享分档-目录树展示方式

模块: 以标题样式显示并自动展开该目录下的一级子标题。 Apifox 分享分档-目录树展示方式

跳转到子级目录: 当某个目录下的内容非常丰富时,可以选择这个样式。点击目录时,会聚焦当前目录内容。 Apifox 分享分档-跳转到子目录展示方式

默认展开目录:

Apifox 分享分档-默认展开目录

  • 默认选型为「全局自动」,会根据所有目录内的内容数量,自动展开/收起目录。使阅读者打开文档时,左侧目录树是丰富的。

    Apifox 分享分档-默认展开目录

  • 你也可以选择「手动设置」,根据你的需要,设置某个目录默认展开/收起。

    Apifox 分享分档-默认展开目录

目录内容展示设置

自定义内容:作为默认选项,点击目录时,会展示目录的文字内容,可作为一个模块的说明。

Apifox 分享分档-目录内容展示设置

展示子级内容列表:点击目录时,会展示该目录下的内容索引,帮助读者快速了解该目录下的内容。

Apifox 分享分档-目录内容展示设置

不展示:点击目录时,仅作为文件夹展开/收起,本身没有内容显示。