数据开发治理平台 WeData 新建 API-操作指南-文档中心-腾讯云

准备工作
在开启数据服务之前，请您确保已经完成了所有前期准备工作，详细见 使用前期准备。
新建 API（向导）
操作场景
通过向导方式完成 API 的创建。
前提条件
完成项目涉及数据服务的数据源配置，详情参见 数据源管理。
操作步骤
1. 登录 数据开发治理平台 WeData 控制台，单击左侧项目列表选择一个项目单击数据服务，进入数据服务首页。
﻿
2. 单击左侧服务开发 > 服务开发，在中间 API 目录树创建 API 目录，API 目录最大支持四级。
﻿
﻿
﻿
参数说明如下：
参数
说明
API 名称
为 API 定义名称，项目内唯一，支持中文、英文、数字和下划线，长度为4 - 60个字符以内。
配置方式
支持向导和脚本配置方式：
向导方式：通过可视化表单方式完成 API 新建，仅支持单表。
脚本方式：通过编写 SQL 实现 API 新建，支持多表连接。
目录文件夹
API 所属文件夹，默认为“默认文件夹”
请求 Path
合法 URL 路径，以“/”开头，支持中文、英文、数字和下划线，长度为4 - 60个字符以内。
参数协议
支持 HTTP 和 HTTPS 两种协议。
请求方式
HTTP 请求方式，可以选择 GET 和 POST。
认证方式
设置当前 API  的认证方式，采用 API 网关的认证，可取值免认证和应用认证：  
免认证：API  网关在收到匿名请求时，也可以通过认证。
应用认证：发布的 API 如果使用应用认证方式（ ApiAppKey  和 ApiAppSecret），客户端在调用 API 时，需要使用签名密钥对请求内容进行签名计算，并将签名同步传输给服务器端进行签名验证。
网关类型
可选择腾讯云原生 API 网关和腾讯云 API 网关。
腾讯云原生 API 网关：腾讯云网关产品，功能与腾讯云 API 网关基本无差别。
腾讯云 API 网关：即将退市，不建议继续使用。
关联网关
WeData 数据服务基于腾讯云 API 网关实现，所以需要关联 API 网关。若没有创建，可根据页面提示创建对应的网关实例。
服务资源组
API 依赖的外部资源，包括 API 网关以及运行服务。
标签
设置 API 的标签，最多设置4个。
可见范围
设置当前 API 用户的查看范围：
租户：当前租户下的所有成员均可查看。
项目：当前项目成员可查看。
私有：仅自己查看。
描述
填写 API 相关的描述信息。
3. 配置 API，经过步骤2，单击确定后，生成 API 新建配置页面，按照需求选择数据来源和参数配置。
﻿
数据来源参数说明：
参数
说明
数据源类型
选择需要配置 API 的数据源类型，支持 Mysql、GBase、Oracle、Elasticsearch、IBM DB2、Clickhouse、SQL Server、PostgreSQL、Doris、TCHouse-P。
数据源
获取当前项目用户有权限的数据源，单击新建数据源，跳转至 数据源管理 页面。
数据库
展示数据源下所有的数据库。
数据表
展示数据库下所有的数据表。
请求和响应参数配置：
参数
说明
参数名
请求的参数名，与 API 调用的请求参数对应，只能填写英文、数字和下划线，64字符以内。
绑定字段
选择数据表的字段，支持搜索。
参数类型
请求参数的类型，支持 Number 和 String。
参数位置
支持选择 Query，Body，Header，其中 POST 请求时显示 Body。
操作符
参数名称操作符，支持 =，<>，>，>=，<，<=，%like%，%like，like%，in，not in。
默认值
表示当前参数的默认值，只能填写英文、数字和下划线，64字符以内。
示例值
用于 API 文档，只能填写英文、数字和下划线，64字符以内。
排序参数配置：
参数
说明
字段名称
数据库表字段，支持搜索，只能填写英文、数字和下划线，64字符以内。
排序方式
支持正序和倒序。
操作
支持字段上移和下移。
高级配置：
参数
说明
超时时间
设置最大超时时间。
4. 完成 API 配置后，单击工具保存，对配置进行保存。
新建 API（脚本）
操作场景
通过脚本方式完成 API 的创建。
前提条件
完成项目涉及数据服务的数据源配置，详情参见 数据源管理。
操作步骤
1. 登录 数据开发治理平台 WeData 控制台，单击左侧项目列表选择一个项目单击数据服务进入数据服务首页。
2. 单击左侧服务开发 > 服务开发，在中间 API 目录树创建 API 文件目录，API 目录最大支持四级。
3. 配置 API ，经过步骤2，单击确定后生成 API 新建配置页面，按照需求选择数据来源和参数配置。
数据来源：
参数
说明
数据源类型
选择需要配置 API 的数据源类型，支持 Mysql、GBase、Oracle、Elasticsearch、IBM DB2、Clickhouse、SQL Server、PostgreSQL、Doris、TCHouse-P。
数据源
取当前项目用户有权限的数据源，单击新建数据源，跳转到项目管理 > 数据源管理页面。
查询 SQL：
参数
说明
查询 SQL
输入查询 SQL 语句，完成输入后自动解析生成请求和响应参数。
请求和响应参数配置：
参数
说明
参数名
请求的参数名，与 API 调用的请求参数对应，只能填写英文、数字和下划线，64字符以内。
参数类型
请求参数的类型，支持 Number 和 String。
绑定字段
选择数据表的字段，支持搜索。
参数位置
支持选择 Query，Body，Header，其中 POST 请求时显示 Body。
操作符
参数名称操作符，支持 =，<>，>，>=，<，<=，%like%，%like，like%，in，not in。
是否必填
请求参数是否必填。
默认值
表示当前参数的默认值，只能填写英文、数字和下划线，64字符以内。
示例值
用于 API 文档，只能填写英文、数字和下划线，64字符以内。
排序参数配置：
参数
说明
字段名称
数据库表字段，支持搜索，只能填写英文、数字和下划线，64字符以内。
操作
支持字段上移和下移。
4. 完成 API 配置后，单击工具保存，对配置进行保存。
SQL 示例：
select
    country, //select字段为API的返回字段
    name as username, //当存在字段别名时，别名作为返回字段 
    max(age) as max_age //支持数据库函数 
from
    table 
where
    hobby=${hobby} //hobby对应API请求参数，格式是${请求参数} 
group by country,name;
请参考示例规范输入 SQL ，输入完成后， SQL 会自己解析为 API 请求响应参数。
参数完成解析后，请补全参数相关定义，以便生成完整的 API 文档给调用方使用。
SQL 支持多表连接，编写时，请注意所选择数据库的语法。
﻿

参数	说明
API 名称	为 API 定义名称，项目内唯一，支持中文、英文、数字和下划线，长度为4 - 60个字符以内。
配置方式	支持向导和脚本配置方式：向导方式：通过可视化表单方式完成 API 新建，仅支持单表。脚本方式：通过编写 SQL 实现 API 新建，支持多表连接。
目录文件夹	API 所属文件夹，默认为“默认文件夹”
请求 Path	合法 URL 路径，以“/”开头，支持中文、英文、数字和下划线，长度为4 - 60个字符以内。
参数协议	支持 HTTP 和 HTTPS 两种协议。
请求方式	HTTP 请求方式，可以选择 GET 和 POST。
认证方式	设置当前 API 的认证方式，采用 API 网关的认证，可取值免认证和应用认证：免认证：API 网关在收到匿名请求时，也可以通过认证。应用认证：发布的 API 如果使用应用认证方式（ ApiAppKey 和 ApiAppSecret），客户端在调用 API 时，需要使用签名密钥对请求内容进行签名计算，并将签名同步传输给服务器端进行签名验证。
网关类型	可选择腾讯云原生 API 网关和腾讯云 API 网关。腾讯云原生 API 网关：腾讯云网关产品，功能与腾讯云 API 网关基本无差别。腾讯云 API 网关：即将退市，不建议继续使用。
关联网关	WeData 数据服务基于腾讯云 API 网关实现，所以需要关联 API 网关。若没有创建，可根据页面提示创建对应的网关实例。
服务资源组	API 依赖的外部资源，包括 API 网关以及运行服务。
标签	设置 API 的标签，最多设置4个。
可见范围	设置当前 API 用户的查看范围：租户：当前租户下的所有成员均可查看。项目：当前项目成员可查看。私有：仅自己查看。
描述	填写 API 相关的描述信息。

参数	说明
数据源类型	选择需要配置 API 的数据源类型，支持 Mysql、GBase、Oracle、Elasticsearch、IBM DB2、Clickhouse、SQL Server、PostgreSQL、Doris、TCHouse-P。
数据源	获取当前项目用户有权限的数据源，单击新建数据源，跳转至数据源管理页面。
数据库	展示数据源下所有的数据库。
数据表	展示数据库下所有的数据表。

参数	说明
参数名	请求的参数名，与 API 调用的请求参数对应，只能填写英文、数字和下划线，64字符以内。
绑定字段	选择数据表的字段，支持搜索。
参数类型	请求参数的类型，支持 Number 和 String。
参数位置	支持选择 Query，Body，Header，其中 POST 请求时显示 Body。
操作符	参数名称操作符，支持 =，<>，>，>=，<，<=，%like%，%like，like%，in，not in。
默认值	表示当前参数的默认值，只能填写英文、数字和下划线，64字符以内。
示例值	用于 API 文档，只能填写英文、数字和下划线，64字符以内。

参数	说明
字段名称	数据库表字段，支持搜索，只能填写英文、数字和下划线，64字符以内。
排序方式	支持正序和倒序。
操作	支持字段上移和下移。

参数	说明
查询 SQL	输入查询 SQL 语句，完成输入后自动解析生成请求和响应参数。

新建 API

本页目录：

准备工作

新建 API（向导）

操作场景

前提条件

操作步骤

新建 API（脚本）

操作场景

前提条件

操作步骤