本文介绍 Apidog 中的核心概念。Apidog 是一款 API 优先的工具，专为高效的 API 设计、测试和协作而打造。许多概念与 Postman 等类似产品不同。理解这些概念将帮助你有效地掌握 Apidog 的工作流程。Apidog 中的 项目 是协作的主要单元，包含模块、环境、测试场景等。它是团队内所有 API 相关工作的容器。项目的关键组成部分#
环境：用于不同部署阶段（例如开发、预发、生产）的变量集。
端点规范：基于 OpenAPI/Swagger 标准的 API 文档。
与 Postman 的比较#
| Apidog 概念 | Postman 中的等价概念 | 描述 |
|---|
| 项目 | Workspace | 用于协作的顶层组织单元。 |
| 模块 | Collection Folder | 对相关端点进行分组。 |
| 团队 | Team | 共享访问和协作功能。 |
项目支持无缝协作，允许多个用户同时处理 API，同时保持版本控制和访问权限。
模块的功能#
可为每个环境配置 Base URL，用于自动生成 URL。
何时使用模块#
默认：新项目从一个模块开始；如果需要多个 Base URL，可按需添加更多模块。
模块与 OpenAPI Specification (OAS) 保持一致，便于与其他工具集成，并保持清晰的 API 边界。
GET /users/{id}）。端点管理#
与 Postman 的区别#
| 方面 | Apidog（基于端点） | Postman（基于请求） |
|---|
| 基本单元 | 端点（API 规范） | 请求（单次调用） |
| 规范变更 | 自动更新用例和测试 | 需要手动重写 |
| 结构 | 带调试能力的 OAS 扩展 | 规范和请求分离 |
在 Apidog 中，端点规范的变更会自动传播到所有依赖的用例，通过这种规范驱动的方法减少维护成本。
关键功能#
自动构建 URL：Base URL + 端点路径。
Base URL 示例#
| 服务 | Base URL（生产） | 端点路径 | 完整 URL |
|---|
| 用户 | https://user.example.com | GET /user/{id} | https://user.example.com/user/{id} |
| 订单 | https://order.example.com | GET /order/{id} | https://order.example.com/order/{id} |
| 产品 | https://product.example.com | GET /product/{id} | https://product.example.com/product/{id} |
无需手动使用 {{BaseUrl}} 占位符；Apidog 会自动检测模块并应用正确的 Base URL。
请求能力#
请求为 API 规范 未预先定义的场景提供灵活性，弥合了设计优先和请求优先工作流程之间的差距。
测试场景#
测试场景 批量执行请求，类似于 Postman Collections，并具备高级自动化功能。高级 能力#
测试场景会随着 API 规范变更自动同步，确保测试在 API 演进过程中保持有效。
设计优先模式与请求优先模式#
Apidog 的 APIs 模块提供两种模式，可在界面左下角切换：Design-first Mode 和 Request-first Mode。两种模式提供相似的功能，但界面不同，适用于不同的团队工作流程。设计优先模式#
请求优先模式#
理解这些核心概念将帮助你利用 Apidog 的 API 优先方法进行高效的设计、测试和协作。从创建项目开始，将端点组织到模块中，为不同阶段定义环境，并构建测试场景以实现自动化。如需进一步阅读，请浏览链接的文档页面，或试用 Apidog 界面以实际了解这些概念。
准备好开始了吗？#
