API 文档完整性检查

INFO

有关设置要求，请参阅 AI 功能入门。注意：此功能需要 Apidog 版本 2.7.55 或更高版本。

概述

你可以使用 AI 对当前 API 文档运行 API 文档完整性检查，并生成详细的评审报告。基于此报告，你可以优化和改进文档——让协作更顺畅、文档更易读，并且由于端点规范更准确，所有 AI 功能也会更加有效。

在运行 API 文档完整性检查 之前，建议先查看当前 API 文档中的描述和定义是否完整。该检查会分析以下方面：

检查端点文档是否清晰且准确地说明了：

元素	目的
请求方法	定义 HTTP 方法（GET、POST、PUT、DELETE），用于确定请求语义、幂等性和参数结构
请求路径	完整的 URL 路径（不包括 base URL），用于唯一标识端点并推断路径参数结构
端点名称和描述	对端点用途的简短说明，帮助读者和 AI 理解业务逻辑

检查端点文档是否清晰且准确地说明了：

元素	目的
参数名称	确保参数结构完整、命名一致，并且每个参数位于正确的位置（Params、Body、Headers、Cookies）
示例	提供有效的示例输入值，帮助理解典型值、格式、数据类型和业务含义
描述	解释参数的含义、用途和业务场景

请求参数的基本信息可以在 AI 的帮助下生成或修改。

检查端点文档是否清晰且准确地说明了：

约束	目的
必填/可为空	指示参数是否必填以及是否允许 null 值
枚举/常量	列出可能的枚举值或常量值及其含义
边界值	提供最小值/最大值、长度限制以及其他约束
格式	描述特殊格式（date-time、email、uuid、binary、int64、json-string 等）