本指南将帮助你快速入门,从设置账户到发起你的第一个 API 请求。视频指南#
前置条件#
Pet Store 项目是 Apidog 内置的示例项目,可帮助你学习关键概念和功能。在 Apidog 欢迎页面点击 Create Sample Project 即可开始。 选择你的开发模型#
| 模型 | 描述 | 最适合 | 工作流 |
|---|
| 设计优先 | 在实现之前定义 API 规范 | 优先考虑规划和文档的团队 | 规范 → 请求 → 测试 → 分享 |
| 请求优先 | 基于实际请求构建和测试 API | 敏捷团队、原型设计、未记录文档的 API | 请求 → 规范 → 测试 → 分享 |
设计优先模型#
在设计优先方法中,你会预先定义 API 规范,以确保在实现之前具备清晰性和一致性。此方法非常适合重视规划并希望从一开始就创建全面文档的团队。1
指定一个新端点使用路径、方法、参数和响应定义你的 API 端点。这会创建 API 规范的基础。
2
切换到设计优先模式在 Apidog 界面的左下角,选择“Design-first”模式以继续设计你的端点。
4
添加断言设置自动化检查,确保你的 API 响应符合预期标准。
7
探索高级功能深入了解 Apidog 的更多能力,例如环境、模式和协作工具。
请求优先模型#
请求优先方法从实际 API 调用开始,让你能够快速对 API 进行原型设计和验证。此方法非常适合使用现有后端、第三方 API,或需要为未记录文档的端点编写文档的团队。2
切换到请求优先模式在 Apidog 界面的左下角,选择“Request-first”模式。
3
添加断言实现自动化验证规则,以确保 API 的可靠性和正确性。
6
探索高级功能探索 Apidog 全面的测试、协作和自动化工具。
在模式之间切换#
你可以随时使用界面左下角的切换开关,在设计优先和请求优先模式之间切换: Modified at 2026-06-09 08:55:47