本文为您介绍如何进入API详情页面,查看API的基础信息、参数信息、返回示例等详情。

进入API详情页面

  1. 登录DataWorks控制台后,进入数据地图页面,操作详情请参见进入首页
  2. 在顶部菜单栏,单击全部数据
  3. 在搜索框上方,选择API类目,单击需要查看的API名称

查看API详情

API详情页面为您展示API的基础信息技术信息参数信息返回示例使用说明API详情
区域 描述
单击编辑API跳转至API所属工作空间的编辑窗口进行API编辑。详情请参见发布API注册API
说明 :如果当前登录账号不在API所属的工作空间中,请联系目标工作空间对应管理员将您的账号添加到目标空间的成员列表中并赋予开发者角色,详情请参见成员及角色管理
在该区域您可以输入API IDAPI PathAPI名称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
  • 使用说明:您可以进行编辑查看历史版本的操作,根据业务说明了解相关的信息。