配置模式生成API 配置取数逻辑 “取数方式”选择“配置方式”: 1.选择数据源、数据连接、数据库和数据表,获取到需要配置的表。 说明 数据服务仅支持部分数据源,详情请参见 DataArts Studio支持的数据源。您需提前在DataArts Studio管理中心中配置好数据源,数据表支持表名搜索。 2.配置参数字段 选择好数据表之后,单击“参数设置”后的“添加”,添加参数页面自动列出这个表的所有字段,分别勾选需要设置为请求参数、返回参数和排序参数的字段,分别添加到请求参数、返回参数和排序参数列表当中。 添加参数 3.编辑请求参数信息 请求参数主要分为三部分,绑定参数、绑定字段、操作符。在请求参数列表中,需要设置绑定参数和操作符。 绑定参数对外开放,是用户访问API时,直接使用的参数。 绑定字段对外不可见,是API调用时,实际访问的内容。 操作符则是用户访问时,对参数的的处理方式。当前支持的操作符及含义如下: 支持的操作符 操作符 描述 检查两个操作数的值是否相等,如果相等则条件为真。 <> 检查两个操作数的值是否相等,如果不相等则条件为真。 > 检查左操作数的值是否大于右操作数的值,如果是则条件为真。 > 检查左操作数的值是否大于等于右操作数的值,如果是则条件为真。 < 检查左操作数的值是否小于右操作数的值,如果是则条件为真。 < 检查左操作数的值是否小于等于右操作数的值,如果是则条件为真。 %like% %like%表示忽略前后缀,进行字符匹配。 %like %like表示忽略前缀,进行字符匹配。 like% like%表示忽略后缀,进行字符匹配。 in in运算符用于把某个值与一系列指定列表的值进行比较。 not in in运算符的对立面,用于把某个值与不在一系列指定列表的值进行比较。 4.编辑返回参数信息 在返回参数列表中,设置参数的名称、参数类型、示例值和描述。 返回参数主要分为三部分,参数名、绑定字段、参数类型。参数名对外开放,是API返回时,最终展示给用户的参数名称;绑定字段对外不可见,是API调用时,实际返回的内容;参数类型则是API调用时,数据的呈现格式,分为数值型和字符型两类。 5.编辑排序参数信息 在排序参数列表中,设置排序字段是否可选,排序方式和描述。 排序参数主要分为四部分,参数名、字段名称、是否可选以及排序方式。参数名对外开放,是API返回时,最终展示给用户的参数名称;字段名称对外不可见,是API调用时,实际访问的内容;是否可选决定了当前排序条件是否允许移除,勾选则表示可以不使用此参数;排序方式分为升序、降序以及自定义,表示了当前参数允许使用的排序形式。 通过排序参数列表中的操作列的向上、向下和删除按钮,可调整排序参数的顺序或者删除某排序参数。 6.单击“下一步”,设置preorderby的值为所有排序参数的描述,以“英文分号”进行分隔。 以如下样例数据为例进行说明: 排序字段对应的参数描述 排序字段 对应的排序参数描述 id a:asc 其中,a是参数名,asc代表升序。 name b:asc b b:desc 其中,b是参数名,因为排序方式是自定义,所以有如上三种参数描述。 age c:desc 其中,c是参数名,desc代表降序。 依据上表,分析得出各个字段对应的排序参数描述,则preorderby的设置方式有如下几种情况,包含所有排序参数的描述。 配置preorderby preorderby 对应的后端order by语句 备注 a:asc;b;c:desc order by id ASC, name, age DESC b;c:desc order by name, age DESC 因a是可选排序字段,所以可以不填。 b:asc;c:desc order by name ASC; age DESC b排序方式是自定义,排序时可选择升序。 b:desc;c:desc order by name DESC; age DESC b排序方式是自定义,排序时可选择降序。 配置排序参数值 说明 preorderby是非必填参数,当未配置preorderby参数值时,则选取非可选排序字段作为排序的依据。 当配置preorderby参数值时,配置类API需严格按照排序参数顺序进行设置。例如 a:asc;b;c:desc ,可行。当设置为b;a:asc;c:desc,则报错。