调用 sql-formatter 美化 SQL

POST

/database:formatSQL

支持 SQL 格式化，可自动根据数据源获取方言或显式指定方言。

方言获取优先级：

显式指定 dialect 参数 2. 根据 sid 查询 yiask_datasource 表获取 client 字段 3. 默认使用 sql

示例：通过 sid 自动获取方言

示例：显式指定方言

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Body 参数application/json必填

示例

{
    "sql": "SELECT * FROM users WHERE id=1",
    "sid": "demo-test"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/database:formatSQL' \
--header 'X-SPACES: default' \
--header 'X-SPACES: {{space}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "sql": "SELECT * FROM users WHERE id=1",
    "sid": "demo-test"
}'

返回响应

🟢200成功

application/json

格式化后的 SQL

Bodyapplication/json

示例

{
    "formatted": "string"
}

修改于 2026-05-12 01:33:48

针对指定数据源执行加密 SQL

获取指定数据源的所有表名