注意:说明:
注意:当前 TSF Consul 已经转为内测,如果你有服务注册配置治理的需求,请你购买 Polaris(北极星)。
一、操作场景
你可以在 TSF 控制台中,通过接口列表查看 API 的详细信息,并进行 API 在线调试。
二、前提条件
要使用 API 列表和调试功能,需要先将服务的 API 注册到注册中心,具体请参见开发手册 API 注册。
三、查看 API 信息
1. 登录 TSF 控制台。
2. 在左侧导航栏单击 TSF Consul 后,选择服务治理,单击微服务的“ID”,进入服务概览页。
3. 在服务详情页,单击顶部的接口列表,会显示服务对外提供的 API 列表。
4. 单击 API 的“接口路径”,可以查看到 API 的详细信息。
API 详情按照应用名/版本号划分显示了 API 的详细信息,包括:路径、方法、描述、入参、出参。其中 Models 表示参数中的复杂类型。
四、手动录入 API
TSF 支持手动录入API,适用于当微服务尚未注册到注册中心,但是希望将 API 进行提前录入,方便配置一些服务治理规则的场景。
1. 在 服务治理 页面,单击微服务的“ID”,进入服务概览页。
2. 在服务详情页,选择接口列表页签,单击手动录入API。
3. 输入 API 路径(其中 path 参数可以使用 {param} 来进行描述),并选择请求方法。
4. 单击确定,完成录入。
五、API 调试
1. 在 服务治理 页面,单击微服务的“ID”,进入服务概览页。
2. 在服务详情页,选择接口列表页签,单击接口操作栏的调试,进入 API 调试页面。
3. 单击右上角的调试,填写调用 API 的默认参数,单击发送请求。
4. 右侧会展示调用 API 的返回结果。