跳到主要内容

接口列表

「服务管理 → 接口列表」集中管理当前项目下的所有接口。页面分为两个页签:

页签内容
编辑中尚未发布、仍在编辑的接口源
已发布各环境当前生效的发布快照,可上下线、同步、回滚与导出

接口列表

编辑中​

编辑中页签列出未发布(或已退回编辑)的接口源,用于继续编辑和删除。

检索与新建​

  • 顶部关键字支持按接口名称、路径检索,按回车或点击「搜索」执行。
  • 列表分页支持 8 / 20 / 50 / 100 条每页。
  • 点击「新建」跳转工作台首页,选择开发模式后创建接口。

列表字段​

字段说明
接口编号接口主键 ID
接口名称点击后跳转接口详情页
接口地址接口路径
分组所属接口分组
认证类型无认证 / 简单认证 / 签名认证
访问范围公开 / 私有
版本接口版本号;点击可查看该版本族
编辑时间最近保存时间
创建人接口创建者
操作编辑、删除

操作说明​

  • 编辑:跳转工作台并打开该接口。已发布接口的编辑入口在「已发布」页签,且需先下线。
  • 删除:删除接口源及其参数、代理配置、测试用例等关联数据。已发布接口不允许直接删除。

已发布​

已发布页签展示各环境的当前生效快照(is_current = 1)。同一接口在不同环境各有一行,因此同一个接口会重复出现。

筛选​

筛选项说明
关键字按接口名称、路径检索
环境选择 dev、prod 或其他项目环境;列表随环境切换
分组按分组树筛选,支持搜索与清空

列表字段​

字段说明
接口编号来源接口 ID(sourceApiId)
接口名称点击打开接口详情页(带环境参数)
分组快照所属分组
认证快照的认证方式
修订号发布快照的修订号(deployRevision),同一接口每次发布递增
版本管理接口版本号;点击打开版本管理弹窗
发布时间快照生成时间
创建人接口创建者
操作随环境不同而变化,见下文

开发环境(dev)操作​

操作说明
编辑仅下线状态可用;跳转工作台编辑接口源
授权为接口批量选择可调用的应用凭证;项目级凭证不可选
同步环境仅上线状态可用;把一个已发布接口同步到其他已启用环境
上线 / 下线切换 dev 快照的可用状态

开发环境上下线有两项额外约束:

  • 从未发布或快照已销毁的接口不能直接上线,需先在工作台点击「发布」。
  • 开发页保存后如果尚未重新发布,列表会阻止直接上线,并提示「已有修改记录,请点击发布重新上线」。上线前必须重新发布,确保运行的是最新内容。

非开发环境操作​

操作说明
历史版本查看该接口在此环境的全部发布快照,可回滚到任一历史修订
上线 / 下线切换当前快照的可用状态;下线后调用方无法访问

非开发环境不能直接编辑,也不能回滚到 dev 快照。内容更新统一由 dev 同步过去。

工具栏能力​

授权应用​

在 dev 行点击「授权」,可为接口选择多个应用凭证。授权结果决定哪些应用能调用该接口:

  • 列表展示应用名称与 AppKey;
  • 项目级凭证(scope=project)不可选;
  • 保存后立即生效,已发布接口的授权会随发布传播到新版本;
  • 点击「新建凭证」跳转应用凭证管理页。

同步到其他环境​

在 dev 行点击「同步环境」打开同步弹窗,按目标环境逐行展示:

列说明
环境名称目标环境
接口版本目标环境当前快照的接口版本
修订号目标环境当前快照的修订号
上次同步时间目标环境当前快照的生成时间
操作同步到该环境

同步前会校验:目标环境存在且启用、dev 快照存在、数据源仍可访问、接口未启用 Mock。若目标环境已是同一修订号,则直接返回现有快照,不重复生成。详见环境与发布。

版本管理​

点击「版本管理」列中的版本号打开弹窗:

  • dev 环境展示版本族中的全部接口源(草稿与已发布),可编辑、升级版本、同步环境、上下线、删除。
  • 非 dev 环境展示同一版本族的发布快照,可上下线、删除。
  • 删除 dev 版本会删除源接口;删除非 dev 版本会删除该接口在该环境的全部快照。

批量删除​

勾选多行后点击「删除」执行批量删除。规则:

  • 只能删除所有环境均已下线的接口;
  • 只要任一环境存在上线快照,整批操作会被拒绝,并提示先下线;
  • 删除会清理发布快照、参数、代理配置、规则关联、测试用例与运行态缓存。

导出 Word 文档​

点击「文档」打开导出弹窗,按当前环境筛选已上线接口,勾选后导出 Word 接口文档。导出内容来自发布快照,而非开发中的草稿。

迁移导入 / 导出​

「导入接口」「批量导出」使用 ApiGo 迁移包在项目或环境之间搬运接口。迁移包包含接口定义、可选的 数据源 / 分组分类 / 测试用例,并支持数据源映射。详见版本与迁移。

刷新(管理员)​

页面右上角的「刷新」仅管理员可见,用于手动补发接口变更通知,触发运行态详情、路由、流控、降级、缓存、IP 规则的重新同步。正常情况下发布与上下线会自动刷新,此按钮用于对账兜底。

常见问题​

现象原因处理
已发布接口找不到编辑按钮接口处于上线状态先下线,再点击编辑
上线按钮不可用接口保存后未重新发布,或从未发布在工作台点击发布后重试
同步环境失败目标环境未启用、数据源未授权或 Mock 未关闭按弹窗错误逐项排查
批量删除被拒绝存在任一环境的上线快照先下线所有环境
导出文档列表为空当前环境没有已上线接口切换环境或先上线

相关文档​