跳到主要内容

分组与分类

ApiGo 用两个彼此独立的维度组织接口:

维度作用结构是否影响权限
分组工作台左侧目录树、接口归属、协作边界树形,可嵌套子分组是
分类业务标签,用于筛选与检索单级列表否

两者都在「服务管理 → 分类管理 → 分组分类」中维护,页面提供「分组管理」与「分类管理」两个页签。

分组管理​

分组树​

分组以树表展示,支持展开/收起与按名称搜索:

列说明
分组名称层级缩进展示,可展开子分组
描述分组说明
创建人分组创建者
创建时间创建时间
关联接口数分组下接口数量;为 0 时以红色提示
操作新增子分组、编辑、删除

分组同时出现在工作台左侧目录树。用户只能看到自己创建的分组以及被授权的分组子树,管理员可查看全部。

新建分组​

点击「新增子分组」打开表单:

字段必填规则
分组名称是不能以 _ 或数字开头;只能包含英文、数字、下划线与中文;长度 2–50
父分组是从分组树中选择
分组描述否最长 50 个字符

保存后分组立即出现在树中,可在工作台把接口归入该分组。

编辑与删除​

  • 只有分组创建者或管理员可以编辑、删除分组。
  • 根分组编辑时父分组不可修改,避免破坏目录层级。
  • 内置分组(ID 为 1)不允许删除,后端会返回「内置分组不能删除」。
  • 删除分组只删除分组记录本身,不会级联删除接口。如果分组下仍有接口,删除后这些接口会失去分组归属,建议先把接口迁移到其他分组再删除。
删除前先处理接口

界面上的「关联接口数」仅作提示,不会阻止删除。删除有接口的分组前,请先在工作台把接口改到其他分组。

分组与权限​

分组是接口可见范围的一部分:

  • 非管理员只能查看自己创建的分组与被授权的分组;
  • 工作台的分组树、接口列表的分组筛选都基于同一套可见分组;
  • 分组授权由系统权限/角色或项目成员配置完成,不在分组表单内直接邀请用户;
  • 项目之间分组完全隔离,切换项目后看到的是当前项目的分组树。

分类管理​

分类列表​

分类是扁平的业务标签,用于给接口打标,便于按业务域筛选。

列说明
分类编号分类主键
分类名称业务分类名称
描述分类说明
关联 API 数使用该分类的接口数量
更新时间最近修改时间
操作编辑、删除

支持按分类名称搜索与分页。

新建与编辑​

表单只有两个字段:

字段必填说明
分类名称是业务分类名称
描述否分类说明

分类为单级结构,当前界面不支持父子分类。一个接口最多选择一个分类;分类是可选项,不填也能保存和发布。

删除限制​

当分类的「关联 API 数」大于 0 时,删除按钮不可用。先把使用该分类的接口改为其他分类或清空分类,再删除。

分类与权限​

分类不参与权限判断:所有能进入分类管理页的用户都可以维护分类,接口也不会因为分类不同而被限制访问。

如何选择​

场景使用
按团队/业务线隔离接口、控制可见范围分组
工作台目录整理、接口归属分组
给接口打业务标签、按业务域检索分类
需要多级组织分组(可嵌套)
需要跨分组统一标记分类(单级)

一个接口必须属于一个分组,但分类可以为空。分组决定「谁能看到」,分类只决定「怎么找」。

常见问题​

现象原因处理
工作台看不到某个分组不是创建者且未被授权由管理员授权分组或项目成员权限
删除分组后接口不见了接口仍指向已删除的分组在接口列表中按关键字找到接口,重新指定分组
分类删除按钮灰色仍有接口使用该分类先调整这些接口的分类
分组名称无法保存以数字/下划线开头或含非法字符按命名规则修改
编辑根分组时父分组置灰根分组不允许改父级如需调整层级,新建子分组后迁移接口

相关文档​