接口管理对应用接口定义进行统一管理,支持根据代码中的@RestController
等注解,进行接口扫描并上报回平台。本文介绍如何配置接口管理规则、查看接口和数据模型详情。
查看接口和数据模型详情
登录BizWorks,在选择平台下拉列表中选中微服务开发平台。
单击页面右上角图标或其文本框区域,在下拉列表中单击目标项目名称后,单击应用页签。在应用列表页面单击目标中心应用名称。
在目标中心应用左侧导航栏中,选择 。
在应用接口管理页面,您可以单击目标接口(或数据模型)名称右侧操作列下的查看,或者在左侧导航栏中单击目标接口(数据模型)。
在目标接口(或数据模型)的详情页面,查看详细信息。
在线调试接口
在应用接口管理页面,您可以单击目标接口名称右侧操作列下的调试。
在在线调试下拉列表中选择目标环境后,按需完成相关参数设置,单击发起调用。
如果页面提示:该环境中未部署过此应用,需要先部署才可以开始调试立刻部署。请单击立即部署,后续操作步骤,请参见部署中心应用实例。
配置接口管理规则
在应用接口管理页面,单击配置接口管理规则。
在配置接口管理规则面板,完成以下信息配置。
参数
说明
自动规则版本
在自动规则版本下拉列表中选择目标自动规则版本。
接口认证
您可以选择需要开启接口认证的环境类型,支持开发、测试、预发和生成。
应用部署的环境类型如果未开启接口认证,则从集群内部、集群外部调用应用接口时无需认证,可直接调用。
应用部署的环境类型如果开启了接口认证,则从集群内部调用应用接口时无需认证,从集群外部调用时,需要配置接口认证信息。
修改配置后,您需要重新部署中心应用才可生效。
单击确定。
代码扫描上报接口信息
在应用接口管理页面,单击接口扫描。
在代码扫描上报接口信息面板,单击扫描代码分支。在扫描代码分支面板的代码分支下拉列表中选中目标代码分支后,单击提交。
您可以在代码扫描上报接口信息面板查看代码扫描状态,如果上报成功,则接口信息更新成功;如果上报失败,则可查看失败的原因。您可以单击刷新,查看最新代码扫描状态。
- 本页导读 (1)