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

如何在API-Management开发者门户中分组API调用优化查找体验

关于API Management开发者门户“Operation list (grouped)”模板的分组功能说明

完全可以!这个模板就是专门为解决你提到的「API操作长列表难以归类」问题设计的,正好能实现按控制器(或Swagger tags字段)分组展示的需求,下面给你详细讲下实现步骤:

一、先确保你的API有可用的分组标识

首先得让APIM能识别到每个操作的所属分组——也就是你说的Swagger规范里的tags字段,通常控制器名称会对应这个标签值:

  • 如果是通过Swagger/OpenAPI导入的API:只要原定义里每个Operation都正确标记了所属控制器的tag(比如"tags": ["UserController"]),APIM会自动同步这些标签,无需额外操作。
  • 如果是手动创建的API:可以逐个给操作加标签:
    1. 进入你的APIM实例,找到目标API
    2. 点击某个操作,切换到「设计」标签页,在「操作」区域找到「标签」字段
    3. 输入对应的控制器名称(比如OrderController),保存即可
    4. 给所有同类操作都加上相同的标签

二、配置“Operation list (grouped)”模板

  1. 打开APIM的开发者门户:进入你的APIM实例,点击顶部导航栏的「开发者门户」
  2. 进入编辑模式:点击页面右上角的「编辑」按钮
  3. 定位到要修改的页面:一般是API的详情页,或者你可以新建一个专门展示分组操作的页面
  4. 添加模板:在左侧的「模板」面板里找到「Operation list (grouped)」,把它拖拽到页面的合适位置(如果原来有普通的操作列表模板,可以替换掉它)
  5. 配置模板参数:
    • 点击模板右上角的铅笔图标进入配置界面
    • 在「数据源」下拉框中选择你要展示的目标API(如果是在API详情页,通常会自动关联当前API)
    • 重点看「分组依据」:这个模板默认就是按照API操作的tags字段分组,刚好匹配你需要的控制器维度
    • 你还可以根据需求调整其他显示选项,比如是否显示操作描述、请求方法图标、是否允许折叠分组等
  6. 保存并发布:点击页面右上角的「保存」,再点击「发布」,让修改生效

三、验证分组效果

发布后回到开发者门户前台,查看对应的API操作列表,你会发现所有操作已经按照标签(也就是控制器名称)分成了不同的组,每个组支持折叠/展开,用户能快速定位到同类操作,完全解决了长列表的识别问题。

额外小技巧:如果你的Swagger标签和控制器名称不匹配,或者需要更灵活的分组逻辑,可以用APIM的set-tag策略批量给操作添加/修改标签,比如给某一类操作统一加上自定义分组标签,这样就能实现更个性化的分组效果。

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

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.05.26 09:06:04