操作场景
TSF 框架在微服务注册时,会自动收集并注册微服务提供的 API 接口,用户可通过 TSF 控制台实时掌握当前微服务提供的 API 情况。接口列表显示服务对外暴露的 API 列表,同时 API 调试提供用户在线调试 API 的能力。
您可以在 TSF 控制台中,通过接口列表查看 API 的详细信息,并进行 API 在线调试。
前提条件
查看API信息
1. 登录 TSF 控制台。
2. 在左侧导航栏选择服务治理,单击微服务的“ID”,进入服务概览页。
3. 在服务详情页,单击顶部的接口列表,会显示服务对外提供的 API 列表。
4. 单击 API 的“接口路径”,可以查看到 API 的详细信息。
API 详情按照应用名/版本号划分显示了 API 的详细信息,包括:路径、方法、描述、入参、出参。其中 Models 表示参数中的复杂类型。
手动录入API
TSF 支持手动录入API,适用于当微服务尚未注册到注册中心,但是希望将 API 进行提前录入,方便配置一些服务治理规则的场景。
1. 在 服务治理 页面,单击微服务的“ID”,进入服务概览页。
2. 在服务详情页,选择接口列表页签,单击手动录入API。
3. 输入 API 路径(其中 path 参数可以使用 {param} 来进行描述),并选择请求方法。
4. 单击完成,完成录入。
说明
同一个微服务下,通过请求路径和请求方法确认唯一的一个 API,不允许创建同请求方法和路径的 API。
当注册中心获取到微服务注册的 API 与手动录入的 API 相同时,会认为是同一个 API。
当注册中心判断某个 API 在当前任何一个部署组上都没有注册,会展示 API 状态为离线。
仅当 API 状态为离线时,该 API 才可以被删除。
API 调试
1. 在 服务治理 页面,单击微服务的“ID”,进入服务概览页。
2. 在服务详情页,选择接口列表页签,单击接口操作栏的调试,进入 API 调试页面。
3. 单击右上角的调试,填写调用 API 的默认参数,单击发送请求。
4. 右侧会展示调用 API 的返回结果。