查看API详情

区域

描述

①

单击编辑API跳转至API所属工作空间的编辑窗口进行API编辑。详情请参见发布API和注册API。

②

在该区域您可以输入API ID、API Path、API名称、API描述等关键字搜索API。

③

在该区域您可以查看该API的如下信息：

• 基础信息：您可以查看API的浏览人数、调用次数、API ID、工作空间、负责人、创建时间、更新时间、描述等信息。

• 技术信息：您可以查看API类型、请求方式、返回类型、数据源类型、数据源名称、表名称等信息。

④

在该区域您可以查看该API的如下信息：

• 参数信息：您可以查看API的请求参数。

  请求参数：您可以查看公共请求参数和应用请求参数的参数名、参数类型、参数位置、示例值、默认值、描述、标签等信息。

• 返回示例：在API发布前，如果对API进行测试并在测试时勾选了自动保存正常返回示例，将根据测试结果更新API返回示例。详情请参见测试API，您可以根据返回示例的数据内容和数据结构了解API返回结果。

• 血缘信息：您可以查看数据表、API、APP之间的完整血缘关系。数据接口API的上游血缘支持的数据源类型包括：Hologres、MySQL、PostgreSQL、SQL Server、Oracle、AnalyticDB for MySQL 3.0、AnalyticDB for PostgreSQL。

  说明

  • 生成API是通过数据源或表封装的API，因此血缘链路将包括：数据表、API、APP。

  • 注册API是通过后端地址封装的API，因此血缘链路将仅包括：API和APP。

  • 血缘信息的产出、更新的时效是T+1。

• 使用说明：您可以进行编辑和查看历史版本的操作，根据业务说明了解相关的信息。