创建API

功能

创建API。

注意事项

无

调用方法

POST

URI

/rest/gaia/dataapi/v1/api

路径参数

无

查询参数

无

请求

• 请求header参数

  表2 请求header参数

  参数	是否必选	类型	值域	说明
  X-Auth-Token	是	string	无	有效的用户Token

• 请求body参数

  表3 CreateDataApiRequest对象属性

  参数	是否必选	类型	值域	说明
  api	是	表4	无	api基本配置
  input_param_definition	否	表5	无	入参定义，最大支持50个
  data_retrieval_logic	是	表6	无	取数逻辑

  表4 CreateApi对象属性

  参数	是否必选	类型	值域	说明
  name	是	string	无	API名称
  catalog_id	否	string	无	所属目录id
  api_path	是	string	无	API path
  project_id	是	string	无	所属项目
  security_level	是	string	无	密级：open(公开) secret(秘密) top(机密)
  request_type	是	string	无	API 请求类型，GET,POST
  description	否	string	无	API描述

  表5 CreateInputParamDefine对象属性

  参数	是否必选	类型	值域	说明
  para_name	否	string	无	参数名称
  para_position	否	string	无	参数位置 query，header，path，body
  para_type	否	string	无	参数类型 number，string
  necessary	否	int32	无	是否必填 0（必填），1（不必填）
  default_value	否	string	无	默认值
  example_value	否	string	无	示例值
  description	否	string	无	描述

  表6 CreateDataRetrievalLogic对象属性

  参数	是否必选	类型	值域	说明
  connection_type	是	string	无	取数类型:config(配置方式)，script(脚本方式)
  script_mode	否	表7	无	脚本方式
  config_mode	否	表9	无	配置方式

  表7 CreateScriptMode对象属性

  参数	是否必选	类型	值域	说明
  dataconnection_id	是	string	无	数据源 只支持高斯类型或CLICKHOUSE类型
  sql_para	是	string	无	取值脚本
  total_size_switch	是	int32	无	调试时是否返回totalSize值, 0:不返回totalSize，1:返回totalSize
  total_size_sql	是	string	无	计算脚本总条数（返回总条数时，该字段有效且必填）
  pagination	是	int32	无	分页方式： 由数据服务分页 用户在sql中自定义分页逻辑
  order_param	否	表8	无	api排序参数，最大支持50个

  表8 CreateApiOrderParam对象属性

  参数	是否必选	类型	值域	说明
  para_name	否	string	无	变量/参数名称
  column_name	否	string	无	字段名称
  optional	否	int32	无	是否可选 0:否，1：是
  sort_type	否	int32	无	排序方式 0：自定义，1：升序 2：降序
  description	否	string	无	描述
  order_num	否	int32	无	参数在orderby中的顺序，配置方式生效，1~50

  表9 CreateConfigMode对象属性

  参数	是否必选	类型	值域	说明
  data_asset_id	是	string	无	数据资产id
  req_param	否	表10	无	请求参数，最大支持50个
  resp_param	是	表11	无	api响应参数，最大支持50个
  order_param	否	表8	无	api排序参数，最大支持50个

  表10 CreateRequestParamMapping对象属性

  参数	是否必选	类型	值域	说明
  api_para_name	否	string	无	绑定参数
  mapping_name	否	string	无	绑定字段
  condition_type	否	string	无	操作符

  表11 CreateApiResponseParam对象属性

  参数	是否必选	类型	值域	说明
  para_name	否	string	无	参数名称
  mapping_name	否	string	无	绑定字段
  para_type	否	int32	无	参数类型 1：integer，2：string，3：long，4：double
  example_value	否	string	无	示例值
  description	否	string	无	描述

• 请求示例

  POST /rest/gaia/dataapi/v1/api HTTP/1.1 
  Host: example.com 
  Content-Type: application/json 
  Accept: application/json 
  { 
      "api":{ 
  	   "name":"string", 
  	   "catalog_id":"string", 
  	   "api_path":"string", 
  	   "project_id":"string", 
  	   "security_level":"string", 
  	   "request_type":"string", 
             "description":"string" 
  	    }, 
  	   "input_param_definition":[ 
  		                     { 
  			             "para_name":"string", 
  			             "para_position":"string", 
  			             "para_type":"string", 
  			             "necessary":"integer", 
  			             "default_value":"string", 
  			             "example_value":"string", 
  			             "description":"string" 
  		                      } 
  	                            ], 
  	    "data_retrieval_logic":{ 
  		                    "connection_type":"string", 
  		                    "script_mode":{ 
  			                          "dataconnection_id":"string", 
  			                          "sql_para":"string", 
  			                          "total_size_switch":"integer", 
  			                          "total_size_sql":"string", 
  			                          "pagination":"integer", 
  			                          "order_param":[ 
  				                                 { 
  					"para_name":"string", 
  					"column_name":"string", 
  					"optional":"integer", 
  					"sort_type":"integer", 
  					"description":"string", 
  					"order_num":"integer" 
  				} 
  			] 
  		}, 
  		"config_mode":{ 
  			"data_asset_id":"string", 
  			"req_param":[ 
  				{ 
  					"api_para_name":"string", 
  					"mapping_name":"string", 
  					"condition_type":"string" 
  				} 
  			], 
  			"resp_param":[ 
  				{ 
  					"para_name":"string", 
  					"mapping_name":"string", 
  					"para_type":"integer", 
  					"example_value":"string", 
  					"description":"string" 
  				} 
  			], 
  			"order_param":[ 
  				{ 
  					"para_name":"string", 
  					"column_name":"string", 
  					"optional":"integer", 
  					"sort_type":"integer", 
  					"description":"string", 
  					"order_num":"integer" 
  				} 
  			] 
  		} 
  	} 
  }

响应

• 响应参数
• 响应示例

  HTTP/1.1 204 No Content 
  Date:Wed,19 Jul 2023 14:15:28 GMT 
  Server: example.com 
  Content-Type: application/json;charset=UTF8

状态码

操作危险级别

Minor