成功发送 API 请求后,Apidog 可以自动解析请求和响应数据,以创建完整的端点规范。这个强大的功能可以节省时间,并确保你的 API 文档准确反映真实行为。将请求解析为端点规范#
对于尚未定义的已成功发送请求,Apidog 可以自动将其解析为端点规范。发送请求后,你可以点击 Save 按钮旁边的下拉菜单,并选择 Save as endpoint,将其保存为端点规范。当你将请求保存为端点时,Apidog 会智能提取以下信息:请求参数:当前请求的请求参数类型将被视为端点中的请求参数规范,当前参数值将被视为请求参数的示例值。
响应 Schema:当前请求的响应数据结构将被解析为响应规范,响应值将被视为响应示例。
在处理现有 API 时,或者当你想基于实际请求/响应数据快速记录 API,而不是手动定义 schema 时,此功能特别有用。
提取响应#
Apidog 支持将响应提取到端点规范中,可以提取为 响应 schema 或 响应示例。这种灵活性允许你选择是更新端点的 schema 定义,还是仅添加一个新的响应示例,用于文档和测试目的。当 API 结构发生变化时,将响应提取为 schema 很有用;而提取为示例更适合用于记录不同的响应场景(成功、错误、边界情况)。