Apidog Docs
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. 项目资源
  • Apidog 学习中心
  • 入门
    • Apidog 简介
    • Apidog 中的基本概念
    • 导航 Apidog
    • 快速开始
      • 概述
      • 创建端点
      • 发送请求
      • 添加断言
      • 创建测试场景
      • 共享 API 文档
      • 探索更多
    • 迁移到 Apidog
      • 概述
      • 手动导入
      • 定时导入(绑定数据源)
      • 导入选项
      • 导出数据
      • 导入自
        • 从 Postman 导入
        • 导入 OpenAPI 规范
        • 导入 cURL
        • 导入 Markdown
        • 从 Insomnia 导入
        • 从 apiDoc 导入
        • 导入 .har 文件
        • 导入 WSDL
  • Mock API 数据
    • 概述
    • Smart Mock
    • 自定义模拟
    • 模拟优先级顺序
    • 模拟脚本
    • 云端模拟
    • 自托管 Runner 模拟
    • 模拟语言(区域设置)
  • 账号与偏好设置
    • 账户设置
    • 生成 OpenAPI 访问令牌
    • 通知
    • 语言设置
    • 快捷键
    • 网络代理配置
    • 备份数据
    • 更新 Apidog
    • 删除账户
    • 实验性功能
  • 发送请求
    • 概述
    • SSE 调试
    • MCP 客户端
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用请求代理 Agent 进行调试
    • 创建请求
      • 请求历史
      • 请求基础
      • 参数和主体
      • 请求头部
      • 请求设置
      • 调试请求
      • 将请求保存为端点
      • HTTP/2
    • 身份验证与授权
      • 概述
      • CA 和客户端证书
      • 授权类型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 身份验证
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 响应和 Cookie
      • 查看 API 响应
      • 管理 Cookie
      • 概述
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 调试用例
    • 测试用例
    • 动态值
    • 验证响应
    • Design-First vs Request-First
    • 生成代码
    • 环境与变量
      • 概览
      • 使用变量
      • 环境管理
    • Vault 密钥
      • 概述
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 动态值模块
      • Airline
      • 动物
      • 颜色
      • 商务
      • Company
      • 数据库
      • 数据类型
      • 日期
      • Finance
      • 食物
      • Git
      • Hacker
      • Helpers
      • 图像
      • Internet
      • 位置
      • Lorem
      • 音乐
      • 数字
      • Person
      • 电话
      • 科学
      • String
      • System
      • Vehicle
      • Word
    • 前置和后置处理器
      • 概述
      • 断言
      • 提取变量
      • 等待
      • 安全
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle 客户端
      • 使用脚本
        • 概述
        • 预处理器脚本
        • 后处理器脚本
        • 公共脚本
        • Postman 脚本参考
        • 调用其他编程语言
        • 使用 JS 库
        • 可视化响应
        • 脚本示例
          • 断言脚本
          • 使用变量
          • 修改请求
          • 其他示例
    • API 调试
      • AI Agent Debugger
      • A2A 调试器
  • 设计 API
    • 概述
    • 创建新的 API 项目
    • 端点基础
    • API 设计指南
    • 模块
    • 配置多个请求主体示例
    • 组件
    • 通用字段
    • 全局参数
    • 端点变更历史
    • 评论
    • 批量端点管理
    • 自定义协议 API
    • Spec-first 模式(Beta)
    • 安全方案
      • 概述
      • 创建安全方案
      • 使用安全方案
      • 在线文档中的安全方案
    • 高级功能
      • 自定义端点字段
      • 关联的测试场景
      • 端点状态
      • 参数列表的外观
      • 端点唯一标识
    • Schemas
      • 概述
      • 创建新 Schema
      • 构建 Schema
      • 从 JSON 等生成 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • Apidog Europe
    • Apidog Europe
  • API 测试
    • 概述
    • 测试场景
      • 创建测试场景
      • 在请求之间传递数据
      • 流程控制条件
      • 从端点和端点用例同步数据
      • 从其他项目导入端点和端点用例
      • 导出测试场景
    • 测试报告
      • 测试报告
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 共享测试数据
      • 定时任务
      • 管理来自其他项目的 API 运行环境
    • 测试套件
      • 概述
      • 创建测试套件
      • 编排测试套件
      • 本地运行测试套件
      • 通过 CLI 运行测试套件
      • 定时任务
    • 测试 API
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
      • 契约测试
    • Apidog CLI
      • 概述
      • 安装和运行 Apidog CLI
      • Apidog CLI 选项
    • CI/CD
      • 概述
      • 与 Github Actions 集成
      • 与 Gitlab 集成
      • 与 Jenkins 集成
      • 通过 Git Commit 触发测试
  • 发布 API 文档
    • 概述
    • 支持的 API 技术
    • 快速分享
    • 查看 API 文档
    • Markdown 文档
    • 发布文档站点
    • 自定义登录页面
    • 自定义布局
    • 自定义 CSS、JavaScript、HTML
    • 自定义域名
    • AI 功能
    • SEO 设置
    • 高级设置
      • 文档搜索
      • CORS 代理
      • 集成 Google Analytics
      • 文件夹树设置
      • 可见性设置
      • 在文档 URL 中嵌入值
    • API 版本
      • 概述
      • 创建 API 版本
      • 发布 API 版本
      • 共享带有 API 版本的端点
  • 分支
    • 概述
    • 创建 Sprint 分支
    • 在分支中测试 API
    • 在分支中设计 API
    • 合并 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch(Beta)
  • AI 功能
    • 概述
    • 启用 AI 功能
    • 生成测试用例
    • 使用 AI 修改 Schema
    • 端点合规性检查
    • API 文档完整性检查
    • AI 驱动的字段命名
    • 常见问题
  • Apidog MCP 服务器
    • 概述
    • 将 Apidog 项目连接到 AI
    • 将已发布的文档连接到 AI
    • 将 OpenAPI 文件连接到 AI
  • 最佳实践
    • 处理 API 签名
    • 访问受 OAuth 2.0 保护的 API
    • 协作工作流
    • 管理身份验证状态
  • 离线空间
    • 概述
  • 管理
    • 管理项目
      • 管理项目
      • 通知设置
      • 管理项目成员
      • 项目资源
        • 数据库连接
        • Git 连接
    • 管理团队
      • 管理团队
      • 管理团队成员
      • 团队活动
      • 团队角色与权限
      • 团队资源
        • General Runner
        • 团队变量
        • 请求代理 Agent
      • 实时协作
        • 团队协作
    • 入门检查清单
      • 基本概念
      • 入门指南
    • 管理组织
      • 管理组织
      • 组织角色与权限
      • 套餐管理
        • 组织中的账单管理员
      • 单点登录 (SSO)
        • SSO 概述
        • 配置 Microsoft Entra ID
        • 配置 Okta
        • 为组织配置 SSO
        • 管理用户账户
        • 将组映射到团队
      • SCIM 配置
        • SCIM 预配简介
        • Microsoft Entra ID
        • Okta
      • 组织资源
        • 自托管 Runner
  • 计费
    • 概述
    • 积分
    • 升级您的套餐
    • 替代支付方式
    • 管理订阅
    • 将付费团队移入组织
  • 附加组件
    • API Hub
    • Apidog Intellij IDEA 插件
    • 浏览器扩展
      • Chrome
      • Microsoft Edge
    • 请求代理
      • Web 中的请求代理
      • 共享文档中的请求代理
      • 客户端中的请求代理
  • 数据与安全
    • 数据存储和安全
    • 用户数据隐私与安全
    • 请求路由与数据安全
  • 参考
    • API 设计优先方法
    • Apidog OpenAPI 规范扩展
    • JSONPath
    • XPath
    • 正则表达式
    • JSON Schema
    • CSV 文件格式
    • 安装 Java 环境
    • Runner 部署环境
    • Apidog Markdown 语法
    • Apidog Swagger 扩展
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 扩展
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支持中心
  1. 项目资源

数据库连接

你可以在项目设置中配置数据库连接详情。配置完成后,你可以通过在前/后置处理器步骤中添加数据库操作,在端点调试和测试期间使用这些连接。这使你能够无缝地从数据库读取数据或向数据库写入数据。
数据库连接设置.png
Apidog 免费版支持连接以下数据库:
MySQL
SQL Server:支持 SQL Server 2014 及更高版本
Oracle(连接 Oracle 数据库需要安装 Oracle Client)
Db2
PostgreSQL
通过升级,你还可以连接:
ClickHouse(需要 Basic 方案)
MongoDB(需要 Basic 方案)
Redis(需要 Basic 方案)

配置数据库连接#

按照以下步骤在 Apidog 中设置数据库连接:
1.
打开 Project Settings → Database Connections。
项目数据库连接设置.png
2.
点击右上角的 + New 来创建数据库连接。
3.
从可用选项中选择数据库类型,填写必要的连接信息,例如主机、端口、数据库名称、用户名和密码。建议使用变量进行填写。完全使用变量填写的数据库连接可以保存到云端以便协作。
DANGER
重要! 使用变量配置数据库连接时,请注意数据安全影响。
数据库连接详情.png
4.
除了使用用户名和密码的本地连接方式外,你还可以通过 SSH 隧道建立更安全的连接,以更好地保护数据传输。
通过 SSH 连接数据库.png
5.
点击 Save,此连接即可在前/后置处理器中使用。

使用数据库连接#

你可以在端点请求的前/后置处理器中添加“Database Operations”来引用数据库连接。添加后,你可以在“Database Operations”中指定数据库连接。
数据库连接前后置处理器.png
以下是数据库操作的具体步骤:
1.
在 Run 标签页(Design Mode)或 Request 标签页(Request Mode)中,导航到前/后置处理器。
2.
将鼠标悬停在 Add PreProcessor 或 Add PostProcessor 上,并选择 Database Operation。
添加数据库操作.png
3.
命名数据库操作并配置数据库连接。确保所选的“Database Connection”已正确设置。了解更多。
配置数据库连接.png
4.
输入 SQL 命令。命令中支持使用 {{variables}} 等变量。
5.
启用 Extract Result To Variable(支持 JSONPath),并根据需要切换 Console Log。
6.
点击 Send 执行端点请求,并在控制台中查看结果。
图片.png
如果你在自动化测试中使用 Database Operation——无论是作为测试步骤,还是在端点请求的前/后置处理器中——都可以按照上述相同步骤进行设置和使用。
INFO
Apidog 支持标准 SQL 查询,但不支持存储过程等复杂 SQL 操作。

重要说明#

在通过请求执行数据库操作之前,请确保已正确保存配置的数据库连接:
如果你的数据库连接使用变量并存储在云端,请确保在相关变量的 Current Value 字段中设置实际的数据库详情(例如主机、用户名、密码等)。或者,你也可以使用设置变量的方法动态配置这些值。
配置变量当前值.png
如果数据库连接使用固定文本并存储在本地,则需要在 Project Settings → Database Connection 中输入实际的数据库详情(例如主机、用户名、密码等)。
输入数据库连接凭据.png
如果你需要通过 CLI 使用数据库连接运行测试场景,点击此处查看详细说明
如果你需要通过 Runner 使用数据库连接运行测试场景,点击此处查看详细说明。

存储机制和数据安全#

目前,Apidog 提供两种存储数据库连接的方式:
存储在 Apidog Cloud:如果数据库连接完全使用变量进行配置,它将作为变量存储在 Apidog 的云服务器上。
存储在本地:如果数据库连接使用固定文本进行配置,它将以纯文本形式存储在本地配置文件中。

存储机制之间的差异#

存储机制存储方式优点缺点
云端在配置中使用变量1. 使与团队成员协作更加便捷。
2. 通过 CI、Runner 等运行测试场景时,你可以使用变量设置数据库连接详情,而无需维护本地文件。
⚠️ 当在变量的初始值中使用明文时,数据库名称和密码等数据将以明文形式传输到 Apidog 的云服务器,从而带来数据安全风险(使用变量的当前值会将数据存储在本地,从而消除此风险)。建议使用 vault variables 以避免数据安全风险。
本地在配置中使用固定文本本地存储,无安全风险1. 协作性较差;每位团队成员都必须单独配置数据库连接。
2. 通过 CI、Runner 或类似工具运行测试场景时,你需要为数据库连接维护专用的本地文件。
WARNING
为了在出色的用户体验与数据安全之间取得平衡,Apidog 建议将数据库连接保存到云端,并使用 Vault 变量来确保数据安全。强烈不建议在与数据库连接相关的变量初始值中使用明文,因为这可能导致严重的数据安全风险。
Modified at 2026-06-09 08:55:47
Previous
管理项目成员
Next
Git 连接
Built with