You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何自定义Docusaurus OpenAPI插件的侧边栏项?

自定义Docusaurus OpenAPI插件的侧边栏标签(显示请求方法+端点)

完全可以通过覆写插件的侧边栏项生成逻辑实现需求,具体做法是在Docusaurus配置中指定自定义的sidebarItemGenerator函数,替换默认的侧边栏标签生成规则:

  1. 打开项目根目录的docusaurus.config.js,找到OpenAPI插件的配置区块
  2. 在插件的sidebarOptions中添加自定义的sidebarItemGenerator函数,根据API的请求方法和端点重写标签:
module.exports = {
  // ... 其他项目配置
  plugins: [
    [
      '@docusaurus/plugin-content-openapi',
      {
        id: 'api-docs', // 你的插件ID,按需修改
        path: './docs/api', // 你的OpenAPI文件路径,按需修改
        routeBasePath: 'api', // API文档的路由前缀,按需修改
        sidebarOptions: {
          sidebarItemGenerator: (item) => {
            // 仅针对API端点类型的侧边栏项修改标签
            if (item.type === 'api') {
              return {
                ...item,
                // 拼接请求方法(大写)和端点路径作为新标签
                label: `${item.method.toUpperCase()} ${item.path}`,
              };
            }
            // 分类、分组等其他类型的侧边栏项保持默认逻辑
            return item;
          },
        },
      },
    ],
  ],
};
  1. 保存配置后重启Docusaurus开发服务,侧边栏的API项就会显示为「请求方法+端点」的格式

如果需要更复杂的自定义(比如区分不同API版本、处理嵌套分组),可以在sidebarItemGenerator函数中扩展逻辑——先通过console.log(item)打印出当前项的完整结构,再根据实际字段调整标签生成规则。

内容的提问来源于stack exchange,提问作者joaorodr84

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.21 06:10:55