跳到主要内容

页面布局设置

视频内容​

页面布局设置功能允许用户自定义 API 在线文档页，包括：添加导航功能，添加文档底部 banner，添加登录注册按钮等。

截屏

点击左侧“在线分享”菜单，进入页面布局设置页面进行调整。支持在模块中添加各种组件，分别是：顶部导航、左侧目录样式、顶部通知、文档内容底部 Banner 区。

顶部导航模块​

顶部导航菜单组件​

提供自定义导航菜单编辑，支持三种类型导航：

  1. 指定接口分组：支持选择所有接口或者某一接口分组
  2. 自定义链接：支持自定义文字链接
  3. 多级菜单：支持定义二级菜单

截屏

按钮组件​

顶部导航右侧功能区支持添加「按钮组件」，例如 icon、按钮、文字链接。

左侧目录样式模块​

「顶部导航」模块和「左侧目录样式」模块无法同时启用。启用「顶部导航」模块后「左侧目录样式」会直接失效。如果要使用左侧目录样式模块，则需要关闭顶部导航模块。

截屏

全部铺开效果：

截屏

收起一级目录效果：

截屏

顶部通知​

支持添加顶部通知模块，可以在 API 文档顶部添加自定义文字内容。

文档内容底部 Banner 区​

支持添加「图片广告」组件，可以在 API 文档底部添加图片。

截屏