接口库管理
API 管理支持将接口拆分到不同的接口库,方便用户以模块、场景、归属等任意方式对接口进行划分及版本管理。当前 API 管理支持平台托管接口库和私有托管接口库两种接口类型。
平台托管接口库
平台托管接口库中存放的接口,由 API 管理后台进行数据存储及持久化。您可对平台托管接口库中的接口进行编辑和管理。
新建项目后无需您手工创建平台托管接口库,平台会自动初始化平台托管接口库及基线版本。目前暂不支持自定义平台托管接口库名称、新建多个平台托管库或删除平台托管接口库。
私有托管接口库
私有托管接口库支持将业务私有的代码库中的 proto 接口文件同步至平台上,通过图形化的交互界面管理接口文件。私有托管接口库中的接口,支持编辑 proto 文件的描述信息及引用路径,不能编辑文件内容、目录结构等信息。
新建私有托管接口库
在「API 管理」->「API 设计」->「接口列表」页面的左上角,点击托管接口库下拉菜单中的「新建接口库」。
在「新建私有托管仓库」页面,配置接口库名称、基线版本分支并绑定路径后,平台以绑定路径作为 proto 文件的默认引用路径。仓库登记成功后,平台会定时同步仓库变更,保障平台展示数据的准确性。
修改私有托管库绑定分支及路径
在「API 管理」->「API 设计」->「接口列表」页面的左上角,点击托管接口库下拉菜单中的「管理接口库」。
注意:
如原有接口已编写测试用例,将会导致用例无法执行,需谨慎操作。
在私有托管接口库列表中,点击需要编辑的接口库所在行的「编辑」。
在「编辑私有托管仓库」页面可以更新接口库名称、重新绑定仓库、路径,提交后平台会将此接口库下接口信息重置并重新绑定。
如该接口库下有创建多个版本,调整仓库信息后,该接口库下的所有版本都会重新绑定和同步。
手动同步私有托管接口库
已登记的私有托管接口库会在每天 0 点自动全量同步,将代码库中的变更同步更新至平台。为提升同步的时效性,可在接口列表右上角点击同步数据按钮,手动触发指定目录或文件的同步操作。
在阅读中是否遇到以下问题?*
您希望我们如何改进?*
如果您希望得到回复,请留下您的邮箱地址。