API 设计指南 - Apidog Docs

需要 Apidog 版本 2.7.22 或更高版本。

Apidog 强烈建议所有 API 文档都按照 OpenAPI (Swagger) Specification 进行设计。你可以参考这篇文章，了解为什么遵循该规范对你的 API 很重要。

Apidog 的许多其他功能，例如 AI 驱动的端点合规性检查、AI 命名等，都依赖于完整且定义明确的 API 设计指南。通过标准化的指南：

Apidog 的其他功能可以更有效地工作

你的团队能够保持一致，并遵循统一的设计原则

在 Apidog 中，你可以点击文件夹树上方的“+”> “New APl design guidelines”来创建新的 API 设计指南。

创建新的 API 设计指南时，你有两个选项：

示例模板（推荐）
使用 Apidog 提供的完整 API 设计指南模板。在大多数情况下，这是推荐选择。该模板基于 OAS（OpenAPI Specification），并参考 Microsoft 的 API 设计最佳实践编制而成。

空白模板
创建一个空白设计模板。此选项仅提供规范的基本结构，不包含详细内容。之后你可以编写团队自己的 API 设计指南。如果你的团队已经建立了标准和最佳实践，这可能是更好的起点。

在选择、预览并确认符合你需求的模板后，项目中将创建一个新的 API 设计指南。你可以根据需要完全自定义其内容。该设计指南将显示在文件夹树顶部，以提醒所有团队成员规范的重要性。