模块 - Apidog Docs

在 Apidog 项目中，你可以使用模块来组织端点。模块类似于技术架构中的“服务”，旨在帮助你更高效地管理和呈现端点——尤其是在基于微服务的系统中。每个模块都包含自己的一组相关端点、组件（例如 schema、响应和安全方案）以及 Base URL（每个环境一个）。

每个模块对应一个完整且独立的 Swagger/OpenAPI 规范文件。

何时使用模块

在以下情况下，使用模块来组织你的端点：

紧密相关的服务：例如，在 AI 项目中：一个模块用于文本生成端点，另一个用于图像生成端点，还有一个用于语音端点。

微服务：例如，在电子商务项目中，你可能有认证、订单和产品服务。

多个 API 版本：例如，你的项目向外部用户公开不同的 API 版本，如 Legacy、LTS 和 Latest。

在项目中，将鼠标悬停在文件夹树顶部，然后点击 + 按钮。在下拉菜单中，选择 新建模块。

输入模块名称并点击保存。新模块将显示在文件夹树中。点击该模块可查看其详细信息，包括：

模块中资源的数据统计

端点用例和测试场景的覆盖率

模块中端点的导出选项

数据源设置

模块变量 – 类似于环境变量，但只能在此模块的端点请求中访问。

创建模块后，它会自动显示在环境管理页面中。你可以为新添加模块中的每个环境分配一个 Base URL。

默认情况下，每个模块的端点请求会自动使用当前环境中为该模块定义的 Base URL，并与端点路径组合使用。一个模块中的端点不能使用另一个模块的 Base URL 来发送请求。

旧版使用模式

如果单个模块包含多个服务（多个 Base URL），你可以在模块内的文件夹或端点级别手动指定要使用的 Base URL。

但是，这种方式属于 Apidog 中较旧的使用模式，自版本 2.7.16 起不推荐使用。相反，我们建议将服务拆分到单独的模块中，每个模块都有自己的 Base URL。