API列表

API列表,用于对通过微服务网关进行路由转发的API进行管理。

查看API列表

基础操作

1.登录微服务引擎实例控制台。

2.点击“服务网关”“API列表”,进入API列表页面。

操作说明

操作名称 操作 详解
创建API 创建新的API。
切换微服务引擎实例 根据需要切换不同的微服务引擎实例。
切换微服务空间 根据需要切换不同的微服务空间。
条件查询 根据需求搜索过滤条件查询API,通过enter键可触发查询。
刷新 刷新表格数据,不清空查询的关键字。
分页 根据需求跳转页码,设置当前页最大显示条数。
编辑 对API进行编辑。
更多操作 包括对API的删除、启用和停用。
停用 停用状态为已发布的API。
启用 启用状态为未发布的API。

创建API

基础操作

1.点击“创建API”,进入创建API页面。

2.填写API信息。

3.点击提交创建完成

属性说明

属性名称 属性说明
微服务引擎实例 选择创建API所属的微服务引擎实例,可在下拉列表中进行切换。
微服务空间 创建API所属的微服务空间,可在下拉列表中进行切换。
API名称 支持中文、大小写字母、数字、"-"、"_", 2-128个字符。
关联服务 当前微服务空间下API可以关联的服务。网关根据设置的“请求地址”将请求转发到所选的服务上。
请求地址 通过网关访问的请求地址,支持精确地址和ant风格,以"/"开头, 支持大小写字母、数字、"-"、"_"、"*", 长度不超过128个字符。
API分组 当前API所属的分组。可以选择当前微服务空间下的API分组。
启用状态 是否立刻启用当前API。
描述 长度不能超过255个字符。
策略配置 YAML格式的策略配置,包含uri、metadata和predicates:
  • uri:必填,支持关联SpringCloud服务、Dubbo服务和可用地址:
    • SpringCloud服务,例如lb://provider,其中provider为服务名
    • Dubbo服务,例如dubbo://demo-provider-dubbo/imse.api.GreetingService/query,其中demo-provider-dubbo为服务名、imse.api.GreetingService为dubbo接口的全限定名、query为dubbo接口中的方法名
    • 可用地址,例如http://ip:port/context
    </li>
  • metadata:非必填,配置路由的元数据,例如在配置dubbo路由时,可配置metadata.dubbo.group:dubbo服务的分组;metadata.dubbo.version:dubbo服务的版本;metadata.dubbo.parameterTypes:dubbo路由调用的方法的参数类型列表,需使用参数类型的全限定名如:java.lang.Integer。
  • Path:默认同步请求地址内容
  • </ul>