用户手册
每一个API卡片信息显示资源名称、路径、涉及数据、权限、调用方式、创建
人和创建时间。其中“涉及数据”显示资源名称/使用的资源的表名称。权限为
私密型的API，仅创建者可查看详情，其他人不可查看详情。
新增GET类API
打开数据资源＞资源交换功能，可查看当前已存在的主题及API。点击新增
按钮，可进入API创建流程，创建流程为向导式创建，选择创建为GET类型。
其中API权限默认值是“公开”。
点击下一步进入配置源信息，配置源信息分为从数据库创建和从资源创建。
其中从数据库创建支持物理表和SQL模式，资源支持物理表模式。使用SQL创
建API时，需注意正确输入所选数据库对应语法，否则数据获取失败；物理表
时，可支持多表关联后查询数据，多表关联时需注意主副表关联字段的类型需
一致；多表联查支持从同一数据源同一数据库或模式进行联查。
151/300
用户手册
SQL类型API在第三步骤中对于未成功解析的参数信息，支持通过增行方式
补充参数信息，帮助API使用者更好的了解API信息：
从资源创建时，资源下拉框点击后可打开资源选择页面，用户可从不同视角选
择资源，并支持资源的搜索。
152/300
用户手册
配置源信息后，点击下一步可进入参数配置，用户需定义请求参数和返回参
数，支持添加常用参数（page和size）及排序规则（单个字段），多表关联
时，可从多张表中选择对应字段：
153/300
用户手册
注意：page参数回传时，第一页需传0。
全部信息定义完成后，用户可选择保存或保存并发布，发布后可正常查询
数据，草稿态无法查询。
新增POSTAPI
打开数据资源＞资源交换功能，可查看当前已存在的主题及API。
点击新增可进入API创建流程，创建流程为向导式创建，选择创建为POST类
型：
154/300
用户手册
点击下一步进入第二步骤，第二步骤分为从数据库创建和从资源创建。其中
从数据库创建支持物理表和SQL模式，资源支持物理表模式。使用SQL创建
API时，需注意正确输入所选数据库对应语法，否则数据获取失败；物理表
时，可支持多表关联后查询数据，多表关联时需注意主副表关联字段的类型需
一致。
根据需求配置表或SQL语句后，点击下一步可进入第三步骤，第三步骤中用
户需定义请求参数和返回参数，支持添加常用参数（page和size）及排序规则
（单个字段），SQL类型API在第三步骤中对于未成功解析的参数信息，支持
155/300
用户手册
通过增行方式补充参数信息，帮助API使用者更好的了解API信息，另外
SQL类型的排序规则需在SQL语句中定义：
参数支持预览示例json，可帮助用户查看当前所需json结构；预览SQL可帮
助用户查看当前配置实际执行时的SQL语句内容，根据目标可调整配置后重
试：
156/300
用户手册
注