作者:陈剑冬 历史版本:1 最后编辑:陈剑冬 更新时间:2024-07-24 17:26
功能简介
数据服务开发提供了快速将数据表生成数据接口的功能。
允许自行编写接口的查询语句,并支持多表关联、复杂查询条件和执行存储过程等能力。
支持创建的接口有:
- 基础:新增、修改、删除、查询、批量新增/修改/删除。
- 高级:SQL语句
创建接口
- 首先选中需要创建接口的服务,点击【创建接口】
- 进入选择接口界面,选择需要创建的类型接口
- 选择接口类型后,进入编辑页面,设置好基础配置、服务配置等信息后,点击保存即可。
- 这样就创建好了第一个接口,列表中会显示接口的名称、编码、请求方式、服务类型、接口类型、是否匿名访问、创建和修改时间、以及可操作的功能。
注意:如果数据集没有主键,就无法使用修改功能。
编辑接口
点击【编辑接口】,进入编辑页面,此时编码和路由地址无法修改。
基础配置
- 接口名称:由用户自定义接口名称。
- 服务编码:填写接口名称后自动生成,只能由字母、数字组成。
- 测试环境:分为本地环境(localhost)和开发环境(域名)。
- 路由地址:服务路由地址,可以通过创建数据服务时自定义。
- 接口协议:接口间遵循的通信方式,目前只支持HTTP。
- 请求方式:GET(请求获取数据)或POST(发送数据)。
- 接口类型:Restful或WebService。
- 匿名访问:是否可以通过匿名代理访问该接口,打开后可在第三方平台直接调用。
- 接口路径:根据路由地址和编码自动生成一个规范化接口。
服务配置
- 模型数据:可在此选择需要请求的数据。
- 请求数据(新增的数据):预览请求的数据。
格式预览
根据选择的接口类型预览请求和返回格式。
Restful:
WebService:
描述信息
选填,对该接口进行说明。
发布新版本
编辑完毕后,点击发布新版本。
在导出的接口文档中可以查看旧版本,暂不支持版本管理。
测试接口
基本配置
预览在编辑页面设置的各项属性。
请求参数示例
在此可以直接填写请求数据,无需加引号。
树:
文本:
返回数据示例
预览接口
接口详情
该页面主要是查看接口的各项配置,无法编辑。
基本配置和接口描述:
返回数据:查看表字段的信息。
请求数据和返回数据: