要开始在你的组织内使用 Apidog,你可以按照以下任务来帮助你的 Apidog 团队顺利起步。建议你首先与团队管理员和组织的 IT 团队协作,在组织内设置、保护和管理 Apidog。然后,你可以通过配置相关设置、邀请成员加入团队并为他们分配角色,以及创建与你的项目相关的资源来设置你的 Apidog 团队。与你的 IT 团队协作#
联系你的 IT 团队,确定添加新软件的流程,该流程因组织而异。以下是常见主题:你的 IT 团队可能需要在设备策略中添加例外,以允许在员工工作站上安装 Apidog。向 IT 团队提供 Apidog 下载链接,以帮助建立此例外。 如果你的组织网络连接位于代理之后,你可能需要相应地配置 Apidog。从你的 IT 团队获取代理连接详细信息,并在 Apidog 中进行设置。如果你已经登录 Apidog,可以通过导航到 Apidog 界面右上角的 ⚙设置 → 代理 选项来设置代理。或者,如果你尚未登录 Apidog,可以在 Apidog 客户端应用登录屏幕的左下角配置代理设置。
如果你的组织在防火墙后运行,你的 IT 团队可能需要为 Apidog 的域名配置允许列表。这可以确保 Apidog 数据与云端同步,并且所有功能都能按预期工作。 设置 Apidog 团队#
首先,你需要决定组织中的哪位成员将担任团队管理员。团队管理员可以注册 Apidog 账号、创建新团队,并自动成为这个新团队的团队所有者。一个团队可以由多个成员组成,并管理多个项目。管理员有权决定哪些成员在特定项目中拥有哪些权限。管理团队成员#
团队所有者可以邀请其他一些成 员成为团队管理员,随后这些团队管理员将负责邀请和管理团队内的其他协作成员。团队管理员可以通过电子邮件或邀请链接邀请其他成员加入团队。在邀请成员加入时,他们可以为成员设置团队内项目的默认权限。这些权限通常包括管理员、编辑者、只读和禁止访问。需要注意的是,在 Apidog 中,团队权限和项目权限是不同的授权级别。团队权限用于管理整个团队,包括团队设置、成员管理和整体团队治理。团队权限包括团队所有者、团队管理员、团队成员和访客等角色。另一方面,项目权限专门用于管理团队内的单个项目。这些权限控制与项目设置、访问控制以及项目范围内协作相关的方面。项目权限由管理员、编辑者、只读或禁止访问等角色组成,用于决定团队成员在特定项目中的控制和访问级别。创建项目#
团队所有者和团队管理员可以在团队内创建新项目。创建项目时,你可以指定项目名称和描述,并根据需要选择合适的项目模板。创建项目后,你可以邀请团队成员加入项目,并为他们分配适当的项目权限。这允许团队成员在项目中协作,并根据分配的权限访问项目资源。迁移数据#
如果你正在从其他 API 管理工具迁移到 Apidog,你可以将现有的 API 数据导入 Apidog。Apidog 支持从多种格式导入数据,包括 OpenAPI/Swagger、Postman 等。要导入数据,请导航到项目设置并选择 导入数据 选项。选择适当的导入格式,并按照屏幕上的说明完成导入过程。配置初始设置#
设置团队并创建项目后,你可以配置初始设置,以根据组织需求自定义 Apidog。这包括:团队设置:配置团队级别设置,例如团队名称、描述和头像。
项目设置:配置项目级别设置,例如项目名称、描述和默认环境。
环境变量:设置环境变量以管理不同环境(例如开发、预发布、生产)。
通过遵循这些步骤,你可以 在组织内设置 Apidog,并开始与你的团队协作进行 API 设计、开发和文档编写。 Modified at 2026-06-09 08:55:47