如何配置接口管理规则和重置接口定义-云原生应用组装平台 BizWorks(BizWorks)-阿里云帮助中心

新建或导入接口

新建接口

登录BizWorks，在选择平台下拉列表中选中微服务开发平台。
单击页面右上角图标或其文本框区域，在下拉列表中单击目标项目名称后，单击应用页签。在应用列表页面单击目标中心应用名称。
在目标中心应用左侧导航栏中，选择应用开发 > 接口管理。
在应用接口管理页面，选择新建 > 新建接口。
在新建接口面板，完成接口名称、接口路径和请求参数等设置后，单击保存。其中基本信息还包含所在目录和OperationId字段，以及描述文本输入区域。请求参数支持Query参数、Path参数和Header参数三种类型。
说明
- 是否注册网关
  新增的接口（例如：导入、反扫、模型自动生成各种方式），默认该选项为开启状态。
  
  接口注册网关后，可提供集群外访问的统一入口，并提供安全防护能力。
  
  如果接口开启了注册网关配置，且应用部署的环境配置了网关服务（网关实例详见项目环境与集群信息），则会在应用部署时将应用接口注册到对应的网关服务。
  
  如果不开启该选项，则应用部署后接口不会注册至网关，仅支持集群内访问，且该应用接口信息不会自动同步至开放平台。
  
  配置变更后需要重新部署应用才能生效。
- 是否启用认证
  该功能仅在接口注册至网关服务后生效。
  
  应用部署后向网关注册应用接口时，平台根据该字段判断是否需要开启安全认证。
  
  如果状态为默认，则是否开启安全认证根据接口全局配置决定。
  
  如果状态为开启，则不管全局配置是否开启，接口在任意环境部署时都将开启安全认证。
  
  如果状态为关闭，则不管全局配置是否开启，接口在任意环境部署时都将关闭安全认证。
  
  配置变更后需要重新部署应用才能生效。
可选：新建数据模型和新建目录。
新建数据模型
1. 在应用接口管理页面，选择新建 > 新建数据模型。
2. 在新建数据模型面板，完成相关配置项设置后，单击保存。
新建目录
1. 在应用接口管理页面，选择新建 > 新建目录。
2. 在新建子目录对话框中，完成相关配置项设置后，单击添加。
可选：单击目标接口名称右侧操作列下的查看，或者在左侧导航栏中单击目标接口（数据模型）。页面左侧以树形导航展示接口目录结构，右侧列表显示各接口的Method、Path、描述、是否注册网关、是否启用认证和更新时间等信息。

在目标接口（或数据模型）的详情页面，查看详细信息。详情页面包含详情、运行和Mock三个页签。详情页签显示接口路径、更新时间、是否注册网关和是否启用认证等基本信息，以及请求参数和响应参数的定义。页面右上角提供代码生成、编辑和删除操作按钮。
可选：在目标接口的详情页面的右上角，选择代码生成 > 生成接口定义代码（或代码生成 > 生成接口请求代码）。下拉菜单中展示上述两个选项。

导入接口

在应用接口管理页面，选择新建 > 导入接口。
在批量导入面板，单击或拖拽目标Swagger文件至虚线框内（仅支持OAS 2标准），完成文件上传操作后，单击开始导入。

编辑接口

在应用接口管理页面，单击目标接口右侧操作列下的编辑。
在编辑接口面板，完成相关配置项编辑，单击保存。

批量删除接口

在应用接口管理页面，选中目标接口（单个或多个）后，单击批量删除。选中后对应行的复选框变为蓝色勾选状态，页面顶部批量删除按钮变为可操作状态。
在二次确认对话框中，单击删除。

删除接口

在应用接口管理页面，单击目标接口右侧操作列下的更多 > 删除。
在二次确认对话框中，单击删除。

在线调试接口

在应用接口管理页面，您可以单击目标接口名称右侧操作列下的更多 > 调试。
在在线调试下拉列表中选择目标环境后，按需完成相关参数设置，单击发起调用。页面包含高级参数设置（可启用接口调用凭证配置和域名绑定），请求参数区域支持配置HTTP Method、Path以及Query、Path、Body、Headers四类参数。Body参数支持树形和代码两种编辑模式，底部提供保存和重置参数按钮。

如果页面提示：该环境中未部署过此应用，需要先部署才可以开始调试。请单击立刻部署，后续操作步骤，请参见部署中心应用实例。此时发起调用按钮置灰不可用。

启用或关闭Mock功能

启用Mock功能

在应用接口管理页面，您可以单击目标接口名称。
单击Mock页签后，单击启用Mock功能。
在编辑Mock配置面板，选择HTTP Status Code，按需完成配置后，单击保存。HTTP Status Code下拉列表支持200 - OK、201 - Created、401 - Unauthorized、403 - Forbidden和404 - Not Found等选项。下方提供Body和Header页签，可单击生成示例值自动填充或手动编辑JSON格式的返回值。

关闭Mock功能

在Mock页签，单击关闭接口Mock。
在二次确认对话框中，单击确定。

重要
关闭接口Mock后，接口Mock服务将无法访问，所有Mock配置不会被清理，当您重新启用接口Mock时可以继续使用。

配置接口管理规则

在应用接口管理页面，单击配置接口管理规则。

在配置接口管理规则面板，完成以下信息配置。面板顶部的说明区域介绍了平台默认接口定义规则，说明无需在开发过程中额外操作；如需调整可在代码中修改定义并通过模型扫描合并上报；存量接口可通过添加注解方式上报。

参数

说明

自动规则版本

在自动规则版本下拉列表中选择目标自动规则版本。

接口认证

您可以选择需要开启接口认证的环境类型，支持开发、测试、预发和生成。

应用部署的环境类型如果未开启接口认证，则从集群内部、集群外部调用应用接口时无需认证，可直接调用。
应用部署的环境类型如果开启了接口认证，则从集群内部调用应用接口时无需认证，从集群外部调用时，需要配置接口认证信息。
修改配置后，您需要重新部署中心应用才可生效。

单击确定。

代码扫描上报接口信息

在应用接口管理页面，单击接口扫描。该按钮位于页面右上角区域。
在代码扫描上报接口信息面板，单击扫描代码分支。在扫描代码分支面板的代码分支下拉列表中选中目标代码分支后，单击提交。面板中显示已有的代码分支扫描记录。扫描代码分支对话框中显示代码库地址，覆盖策略为使用代码接口定义覆盖现有接口定义。

您可以在代码扫描上报接口信息面板查看代码扫描状态，如果上报成功，则接口信息更新成功；如果上报失败，则可查看失败的原因。面板以表格形式展示各分支的分支名称、状态和最后扫描时间。您可以单击刷新，查看最新代码扫描状态。