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
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. 开发和调试 API
  • 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. 开发和调试 API

概述

Apidog 提供了一整套功能,旨在利用 API 规范简化测试和开发流程,让 API 调试变得简单高效。以下是 Apidog 提供的主要调试功能概览。

自动生成用于调试的请求#

Apidog 会根据你的 API 规范自动创建请求参数和主体,从而提高调试过程的准确性和效率。
生成请求: 根据你的 API 规范中定义的内容自动创建请求参数和主体,确保测试过程中的准确性并节省时间。
动态值: 向你的请求中注入真实且动态的值,模拟真实场景,并帮助识别处理数据变化时可能出现的问题。
调试用例: 允许你将请求参数和主体的配置保存为可复用的端点用例,使回归测试和重复测试更加高效。

轻松实现自动化可视化测试#

借助 Apidog,你可以无需手动设置即可对 API 响应进行可视化测试,确保你的 API 在不同场景下都能按预期运行。
验证响应: 根据你的 API 规范自动验证 API 响应,捕获不一致之处并确保合规性。
可视化断言测试: 提供用于创建断言的 GUI,让你无需编写大量代码即可更轻松地定义 API 响应必须满足的条件。
完全兼容 Postman 脚本: 将你现有的 Postman 脚本导入 Apidog,用于创建可视化断言和自动化测试,在保留现有测试套件的同时,借助 Apidog 的高级功能进行增强。

超越竞争对手的独特能力#

Apidog 提供了在市场中脱颖而出的独特工具,能够支持更全面的 API 测试,尤其适用于复杂环境。
API 调试中的数据库连接与 CRUD: 直接从 Apidog 连接到你的数据库,在 API 测试中执行 CRUD 操作,这对于端到端测试和更复杂的 API 序列至关重要。
外部编程语言集成: 通过与外部编程环境集成来扩展 Apidog 的能力,支持定制化的测试设置和测试工具。
支持微服务架构: 针对微服务架构进行了优化,可无缝协作并提供强大支持,让管理和调试基于微服务的应用程序更加轻松。

其他功能#

Apidog 还提供了其他工具和模式,用于增强你的调试实践和 API 开发工作流。
设计优先 vs. 请求优先: 在设计模式和调试模式之间切换,以便专注于编写 API 规范或调试 API 实现。
生成代码: 自动生成多种编程语言的代码片段,帮助开发者集成 API 或在本地复现问题。
从请求自动生成 API 规范: 如果你的 API 规范已过时或缺失,Apidog 可以从请求中反向生成 API 规范。
通过利用 Apidog 全面的调试功能套件,开发者可以显著减少 API 测试所需的时间和精力,确保 API 解决方案稳健、可靠且可扩展。

不同团队的最佳实践#

面向 API 设计优先团队#

API 设计完成后,后端开发团队可以使用 API 规范来开发和调试 API。Apidog 提供以下开发和调试功能:

开发前#

生成代码:Apidog 允许根据 API 规范生成多种编程语言的客户端 SDK、服务端桩代码和 API 文档。这个自动化过程可以节省时间,并确保 API 实现过程中的一致性。

开发后#

生成请求:Apidog 允许你根据 API 规范生成请求。
动态值:动态值允许你在每次发送请求时,根据预定义规则生成一个新值。这有助于简化调试流程,并确保每个请求都包含唯一数据。
环境和变量:Apidog 支持配置不同的环境和服务,使开发者能够在开发、测试和生产环境的设置之间切换。此功能为在各种条件下测试 API 提供了灵活性。
验证响应:开发者可以根据预定义的 schema 或条件验证 API 响应,确保 API 返回的数据符合预期格式和内容。这有助于维护 API 响应之间的数据完整性和一致性。
前置和后置处理器:Apidog 支持定义在发送 API 请求之前和之后执行的前置和后置处理步骤。这些操作可以包括数据处理、日志记录、错误处理,或任何用于准备 API 响应或处理 API 响应的必要操作。
脚本:开发者可以在 Apidog 中编写并执行脚本,从而在 API 开发和测试过程中对任务进行高级自定义和自动化。脚本可用于执行复杂操作、与外部系统交互,或增强 API 请求和响应的功能。
调试用例:Apidog 中的端点用例是针对特定 API 端点的预定义测试用例,用于简化 API 测试的创建、管理和执行流程,并将其集成到自动化测试工作流中。

面向代码优先团队#

如果你的团队采用代码优先的开发方式,Apidog 提供了一系列工具来支持该工作流:
Apidog IDEA 插件:该插件允许你从代码生成 API 规范,将代码优先开发流程与 API 文档创建无缝集成。
定时导入:Apidog 提供了从 Swagger 自动同步的功能,确保你的 API 文档始终与代码中的变更保持同步。
设计优先 vs. 请求优先:借助调试模式功能,你可以在调试时实时修改 API 规范,从而在开发和测试代码的过程中持续迭代 API 设计。
动态值:动态值允许你在每次发送请求时,根据预定义规则生成一个新值。这有助于简化调试流程,并确保每个请求都包含唯一数据。
环境和变量:Apidog 支持配置不同的环境和服务,使开发者能够在开发、测试和生产环境的设置之间切换。此功能为在各种条件下测试 API 提供了灵活性。
前置和后置处理器:Apidog 支持定义在发送 API 请求之前和之后执行的前置和后置处理步骤。这些操作可以包括数据处理、日志记录、错误处理,或任何用于准备 API 响应或处理 API 响应的必要操作。
脚本:开发者可以在 Apidog 中编写并执行脚本,从而在 API 开发和测试过程中对任务进行高级自定义和自动化。脚本可用于执行复杂操作、与外部系统交互,或增强 API 请求和响应的功能。
调试用例:Apidog 中的端点用例是针对特定 API 端点的预定义测试用例,用于简化 API 测试的创建、管理和执行流程,并将其集成到自动化测试工作流中。
Modified at 2026-06-09 08:55:47
Previous
概述
Next
生成请求
Built with