高水准的开发：能用AI解决的问题，绝不自己动手去写

与其他同类工具相比，Apipost最大的优势在于无需登录即可使用，支持离线调试，同时保持了对复杂测试场景的支持。

作为国内领先的API研发协同管理工具，Apipost已形成从API设计、调试、文档生成、自动化测试到性能测试的完整闭环。其平台同时在线人数突破10万，尤其在AI大模型集成、文档智能化生成领域持续突破，成为数百万后端开发者构建高效研发链路的核心工具。

对于开发人员和软件测试人员来说，最重要的是有一款量身定制的接口调试工具，可以让开发和测试工作事半功倍。Apipost是AI驱动的集API设计、调试、文档生成、自动化测试、性能测试于一体的API开发协作管理平台，功能全面，尤其适合注重团队协作和轻量体验的用户。

一、Apipost核心优势

• 无需登录，离线可用：Apipost无需账号登录，支持离线调试，保护用户隐私，提升效率；

• 高效的AI智能开发助手：集成AI大模型，解决接口开发测试过程中命名难题、手动维护文档繁琐等痛点问题，实现API设计、调试、文档生成和自动化测试的闭环高效开发管理；
  

• 超轻量设计：资源占用少，加载迅速，适合对性能敏感的用户；
• 100%兼容Postman脚本语法：用户可以无缝迁移现有Postman脚本，降低学习成本。

• 团队协作与文档支持：提供团队协作功能，支持生成Swagger、OpenAPI等格式的文档，方便开发团队共享。
  

• 模拟服务器功能：基于OpenAPI规范快速搭建模拟服务器，方便前端开发对接。
  

  Apipost = Postman + Swagger + Mock + Jmeeter + AI

  适用场景
  
• Apipost非常适合需要团队协作、注重文档管理和轻量体验的API开发团队。
• Apipost分为SAAS版和企业版。SAAS版免费，企业也可以根据需要进行私有化部署。
  
  

二、Apipost的操作环境

Apipost适用于不同的操作系统，Windows X32、Windows X64、Linux、Mac系统等。

Apipost官网：https://www.apipost.cn

三、Apipost离线模式

Apipost支持不登入使用，不联网使用，内网下使用。

离线模式下可支持接口调试的绝大部分功能。满足用户在公司内网下进行接口调试的需求。 

注意：在内网和不联网环境下，需退出账号变为游客模式才可正常使用。如果已经登入账号，需要先联外网退出后，变为游客模式才可以。

功能说明

在游客模式下支持HTTP、SSE、TCP、WebSocket类型的接口调试，并且支持一键压测功能。

同样支持使用cookie、全局参数、全局变量、环境变量、以及系统设置。但是离线模式下仅支持创建一个环境和一个服务，需要使用多个环境仍需要登入账号。

游客模式仅支持个人独立使用，如果您需要与团队成员协作，建议您登入账号后与团队伙伴进行协作。

在不联网的环境下，打开客户端约5s后，会出现一个 network error 的报错，不影响功能使用，可忽略。

关于数据

在游客模式下创建的接口数据存储在本地设备，清除缓存或者卸载工具数据则可能会造成丢失。

从游客（离线）模式登入账号后，Apipost会自动检测本地是否存在离线本地数据，当本地存在数据时，就会弹出弹窗，引导如何处理本地数据。

Apipost支持将离线数据导出为swagger或存储至云端

• 导出swagger：会将数据导出为文件，依旧保留本地数据，在退出账号后还可以见到

• 移动数据：会将本地数据移动至云端存储，不再存储于当前设备中。退出账号后就无法看到本地的接口数据
  
  

四、Apipost AI助手

在API 开发与协作中，繁琐的手工操作（如接口命名、文档维护、测试用例编写）和文档一致性问题是常见的效率瓶颈。Apipost 深度集成 AI 大模型，为开发者和测试工程师提供了一套闭环解决方案，显著提升 API 设计、调试、文档生成及自动化测试的效率。

Apipost 的 「AI 智能开发助手」，通过自动化 API 生命周期中的关键环节（设计辅助、文档生成、测试构建），切实解决了开发者和测试人员的实际痛点。其核心价值在于显著减少重复劳动、提升产出物（代码、文档、测试）质量、并确保全流程信息一致性，最终驱动团队协作效率的实质性提升。对于追求工程效能的后端团队和测试团队，这是一个非常值得推荐和整合的关键工具，接下来就带大家详细了解Apipost的部分AI功能。

（一）、AI智能提取API文档

「AI智能提取API文档」是一个集文档生成、接口调试、Mock服务一体化的智能工具，支持用户通过粘贴文档内容，一键生成标准化的API文档，并可直接进行接口调试与模拟返回。该功能极大提高了文档处理效率，提升了团队协作与开发流畅度。

操作步骤

1. 打开功能入口

• 在“API管理”模块的“新建操作”中选择“AI智能提取API文档” ，点击后将直接打开提取弹框入口。

• 或在Apipost“API管理”模块默认页面中，直接就能够找到「AI智能提取API文档」入口。

2. 粘贴文档信息

如果你手头是 Word 等格式的离线API文档，请：

• 复制文档中的接口内容（支持接口说明、请求方式、URL、参数、响应等结构）

• 粘贴至工具提供的输入区域。

（例如：选择开放平台的OpenAPI进行文档粘贴

3. 自动识别与生成中

粘贴内容并点击「生成」按钮后，系统将自动打开右侧的「AI 智能提取 API 文档-生成中」抽屉，展示正在解析的进度。无需手动操作，等待系统完成API信息的识别与结构化。

4. 查看生成结果

• 生成过程中，页面将展示格式化后的接口文档信息，支持编辑修改。

• 生成完成后，点击页面右上角的「保存」按钮，即可对接口文档进行分享或调试。

5. 接口调试 & Mock服务使用

系统已自动解析接口参数及响应格式，支持直接在页面内进行调试。

• 自动生成可访问的「Mock URL」，供前端开发直接使用

• 自动生成在线API文档

• 自动生成调试接口

常见使用场景

注意事项

• 粘贴内容请尽可能保持接口结构完整（如：请求方式、URL、参数、响应结构），以提升AI识别准确性

• 当前版本暂不支持扫描图片中的API内容

• 若AI识别不准确，可手动补充后再生成引用文档

（二）、API Helper

Apipost「API Helper」支持覆盖参数命名、补全文档、生成模拟数据和更新参数值等多种常见场景，极大地提升开发效率。它能够智能分析接口参数，自动为您规范命名，并完善文档内容，省去重复劳动。

规范化命名参数

• 使用场景： 在以API设计为优先的环境下，首先需要设计接口的请求和响应参数。

• 解决问题： 常常为参数命名苦恼，缺乏标准化的命名规则和足够的词汇储备。

• 使用方法： 只需描述您希望命名的参数或相关场景，AI即可为您生成规范化的参数名称，您还可以指定希望遵循的命名规范。点击复制即可使用

AI生成模拟数据

• 使用场景： 在接口调试过程中，需要一些符合真实业务场景的数据以进行测试。

• 解决问题： 真实数据的缺乏和无法满足所有场景的mock数据生成，使得调试过程复杂且繁琐。

• 使用方法： 描述需求及业务场景或输入参数名称，AI将快速生成模拟数据，助力接口调试。

批量更新参数值

• 使用场景： 在接口调试时，为了保证数据符合真实业务场景，可能需要批量更新参数值。

• 解决问题： 使用mock数据功能无法覆盖所有场景，手动操作的流程冗长而繁琐。

• 使用方法： 直接描述需求或输入参数名称，AI将迅速帮批量更新符合情境的参数值。

批量补全参数描述

• 使用场景： 在完成请求和响应参数设计后，可能需要快速补全参数描述信息。

• 解决问题： 手动填写描述内容既繁琐又低效，常导致工作流程的拖延。

• 使用方法： 选择需要补全的参数位置，勾选相关key，AI将自动生成参数描述，我们只需一键同步至接口即可。

一键补全文档

• 使用场景： 在日常调试接口的过程中，往往都是快速输入接口信息并进行测试。许多开发人员常常忽略或懒得填写接口文档中的详细信息，因为这会占用他们宝贵的时间和精力。

• 解决问题： 手动填写文档往往耗时而繁琐，而接口调试的步骤需要快速进行，使用此功能可轻松提高文档填写的效率，确保文档与接口信息同步。

• 使用方法： 仅需一键点击，AI将自动生成接口文档的相关内容，生成完成后，可以直接保存或选择分享，从而节省时间，专注于改善和优化代码。

（三）、AI智能生成测试用例

集成行业领先的8层质量检测机制，实现一键批量创建全面测试用例，有效拦截61.4%潜在线上缺陷。自动生成详细的测试报告，帮助快速定位问题，极大缩短问题修复周期。

Apipost AI智能生成测试用例

可以通过点击「生成测试用例」按钮，利用AI生成符合当前接口信息的测试用例。AI会基于8大测试维度自动生成测试数据，并提供多种操作选项，包括下载、应用、应用并测试等，最终生成的测试用例将保存在AI数据池中，同时支持生成测试报告以便后续查看和分析。

生成接口用例

1. 入口

进入「接口用例-AI数据池」 - 选择生成维度（可以根据实际需求取消或调整所选维度，推荐保留默认设置，以确保测试的全面性和准确性。）

2. 开始生成接口用例

点击「一键生成测试用例」按钮，进入二级页面——「AI生成用例预览」面板。AI将根据当前接口信息和选择的维度自动生成相应的测试数据。

生成过程通常会花费几秒到几分钟的时间，具体时间取决于接口的复杂程度及测试维度的数量。

生成完成后，页面右上方会出现以下按钮：

「下载测试数据」：点击后下载测试数据，方便离线使用。 


应用：点击后「保存测试用例」到「AI数据池」中，并关闭当前界面。 


应用并测试：点击后执行「应用」操作并开始进行接口用例测试，进入「执行测试用例界面」。

3.执行测试用例

点击应用并测试按钮后，将进入「执行测试用例界面」，界面结构如下：

执行进度显示：用以显示当前测试用例的执行进度。

用例执行：以用例分组/用例/用例数据的维度进行用例数据的执行。 


查看执行详情：每一条测试数据右侧会有一个「查看执行详情」按钮，点击后将打开二级抽屉「用例执行详情」，展示包括测试结果、日志信息等。支持在此页面进行简单调试，帮助快速定位问题。

4.生成测试报告

当所有测试用例执行完成后，页面中将显示「AI生成报告」按钮，点击后，AI将根据当前的执行信息，自动生成该次测试的详细测试报告结果。报告包括以下内容：

• 测试概况：测试开始和结束时间、执行的测试用例数量等。

• 用例结果分析：每个测试用例的执行结果，以及智能分析结果。

• 测试结论：根据测试用例最终生成测试结论。

提示：测试报告生成完成后，将自动被保存在“接口用例-测试报告”列表中，可以随时查看或下载以供后续分析。

5.AI用例池

通过AI生成的用例数据都将存储在「AI用例数据池」中，可以通过 同步数据至常规数据池 功能将AI数据同步到常规数据池中，进行批量执行或在自动化测试中进行引用执行。｜

️同步规则： 由于数据特殊性，我们默认最小生成维度是测试数据，即一条用例测试数据将生成常规用例池的一条测试用例。

• 常见问题

  
  Q1:测试用例生成失败，怎么办？

  A:如果在生成测试用例时遇到问题，可以尝试：检查当前接口是否已经配置正确或检查当前团队或个人积分是否有剩余积分。若问题仍然存在，联系技术支持团队进行处理。
  

• 
  Q2:测试用例执行过程中遇到问题，如何调试？ 

• A:您可以通过 查看执行详情按钮进入执行详情页面，查看日志信息并进行简单调试。如果问题较复杂，建议导出日志并联系开发人员进行更深入的分析。

（四）、AI补全参数描述与参数值

通过AI智能推荐，快速补全接口参数的描述信息，解决手动填写繁琐且效率低下的问题，确保参数文档更加规范、准确。

AI补全

• 使用场景： 当存在参数名称但缺少对应的参数值或参数描述时，传统需要手动逐一填写和维护，效率较低且易出错。

• 解决痛点： 彻底避免繁琐的手动操作，提升填写速度与准确性。

• 使用方法： 只需一键点击，AI即可智能识别参数名的语义，自动补全对应的参数值和参数描述，极大简化维护流程。

使用方法

• 普通的form表单

当需要为Header、Query、Path、Body（form-data、urlencoded）、Cookie补全参数描述等信息时：

• 在表单的右上角点击批量补全。同时这里也可以进行批量编辑、批量导入

• 点击 AI补全 按钮，即可进行补全

• 最后点击确定，即可同步补全后的信息

• Body为raw格式

当body为raw格式时，支持直接在json中填写注释，例如：

{
"name":"Jhon", //用户姓名
"age":"34"
}

1. 点击字段描述，会自动提取json中的注释作为参数描述信息

2. 然后点击批量补全，可以对缺少的注释信息进行补全

3. 点击确定即可同步

Apipost AI生成模拟参数值

（五）、智能转换

智能识别文档中的参数和代码结构（CodeStruct），一键粘贴即可自动填充接口入参，极大提升接口调试和文档整理速度。

文档转参数

我们可以从已有的接口文档中复制粘贴，或者从第三方开放的API文档中进行复制。例如我们要将Apipost开放文档中的参数进行快速填写

OpenAPI文档地址： https://doc.apipost.net/docs/detail/2a37986cbc64000?target_id=23796913b176e2

批量复制

粘贴，并选择导入的方式，点击生成

扩展设置：可以选择是否补全参数值、参数描述等信息 

覆盖方式：追加表示不会覆盖当前已有信息将参数追加到最后；覆盖表示会清空已有数据，以当前数据为准 

命名方式：可以选择将原本的参数名修改为符合自己要求的命名方式

预览并进行导入

代码结构（CodeStruct）

如果已经有了代码结构体，也可以通过代码结构体的方式进行快速导入。如这是一段Java的代码结构体

// 订单实体类
class Order {
    private String orderId;       // 订单ID
    private String userId;        // 用户ID
    private BigDecimal amount;    // 订单金额
    private OrderStatus status;   // 订单状态
    private Date createTime;      // 创建时间
    private Date updateTime;      // 更新时间
}

第一步：选择开发语言，并粘贴代码结构体

第二步：选择导入的方式

第三步：预览并导入

（六）、AI生成脚本

AI生成脚本允许用户通过输入自然语言描述的场景需求，获取由AI生成的可直接使用的脚本代码。该功能适用于快速填写自定义脚本，进行提取设置变量、加密解密、断言响应体等功能。

适用场景

• 需要对参数进行复杂的加解密

• 需要获取或设置变量

• 需要动态处理请求参数

使用步骤

1. 输入场景描述

在输入框中，用自然语言详细描述你需要的脚本功能。

描述越详细，生成的脚本越符合需求。

优秀描述示例：

"我需要一个脚本，在脚本中发送一个请求到https://demo-api.apipost.cn/api/demo/login，请求参数为mobile:18289454846 ver_code:123456 并将获取到的token设置为环境变量"

2. 点击发送

点击按钮提交你的请求。AI将分析你的需求并生成相应JS代码。

3. 获取和验证脚本

AI返回的脚本代码会直接插入到编辑器中，可在编辑器内进行查看

4. 调整和优化（可选）

如果生成的脚本不完全符合需求，你可以：

• 修改原始描述并重新生成

• 直接编辑生成的代码

Apipost AI生成前后置脚本

1. 生成的代码应视为初稿，需进行测试和验证

2. 复杂业务逻辑可能需要人工调整

3. 安全敏感场景应进行代码审查

4. 极新的技术可能不被完全支持

常见问题解答

Q1: 适用范围，在哪些地方可以支持AI生成脚本功能？ 

A: 支持在全局参数、目录参数、Http接口、接口用例、SSE类型、GraphQL、自动化测试中均可支持AI生成脚本的功能

Q2: 支持哪些编程语言？ 

A: 仅支持JavaScript

Q3: 如何处理生成脚本中的错误？ 

A: 可以手动在编辑器内进行修改优化，或者重新详细描述你的需求重新生成脚本。

Q4: 能否生成完整的应用程序而不仅是脚本？ 

A: 该功能仅适用于生成调试过程中需要的JavaScript的脚本

Q5: 如何提高生成脚本的质量？ 

A: 提供更详细的描述、示例和约束条件，迭代优化。

（七）、AI生成函数

ApipostAI生成函数功能允许用户通过输入自然语言描述的功能需求，获取由AI生成的纯JavaScript函数代码（不依赖第三方库）。该功能专注于生成独立、可复用的自定义函数单元，帮助开发者快速实现特定功能逻辑。

Apipost AI生成函数

适用场景

需要对参数值行特殊的函数处理，而系统内置的已有函数不支持，例如：

• 对参数值的中空格进行去除

• 对参数值中的非法字符进行处理

• 将日期格式转换为时间戳格式

• 对参数进行特殊的加解密处理

使用限制

1. 仅支持原生JavaScript

2. 不生成依赖第三方库的代码

3. 不生成完整程序或类实现

使用步骤

首先在「项目设置-自定义函数」中点击「新建」函数

1. 输入功能描述

在输入框中用清晰的语言描述你需要的函数功能，包括：

必须包含的要素：

• 函数的主要目的

• 输入参数及其类型

• 期望的输出结果

• 关键处理逻辑

优秀描述示例： 

"需要一个函数，接收任意字符串，返回一个新的字符串，其中需要将原字符串总的所有空格去除"

2. 指定特殊要求（可选）

可包括：

• 性能考虑（如时间复杂度要求）

• 编码风格偏好

• 边界条件处理

• 错误处理方式

示例：

"函数应该处理空数组输入的情况，返回空数组而不是报错。"

3. 提交生成请求

点击"生成函数"按钮提交请求

4. 获取生成结果

AI返回的结果将会直接追加出现在编辑器中

5. 测试与调整

• 在提供的验证功能里可以进行简单的测试，对函数进行验证

• 如需调整可直接修改生成的代码，或者修改描述重新生成

描述编写指南

推荐做法

✅ "生成随机RGB颜色字符串的函数，格式如'rgb(255,100,50)'"

✅ "实现数组去重函数，要求时间复杂度O(n)"

应避免的做法

❌ "写一个React组件"（超出函数范围）

❌ "用jQuery实现..."（依赖第三方库）

❌ "做一个购物网站"（范围过大）

常见问题

Q1: 添加的函数如何使用 

A: 查看使用文档

Q2: 为什么我的函数描述没有生成正确结果？

A: 请检查是否：

1) 描述了具体处理逻辑 

2) 明确了输入输出 

3) 需求可实现性

（八）、AI生成断言

Apipost「AI生成断言」功能可自动分析接口响应体结构，快速生成JavaScript断言脚本，帮助开发者高效完成接口测试验证工作。支持一键生成基础断言和按需补充定制断言。

Apipost AI生成接口断言

核心能力

✅ 智能分析：自动识别响应体字段类型和结构
✅ 批量生成：一次生成多个关键断言语句
✅ 灵活补充：根据用户描述追加特定断言
✅ 即插即用：生成的代码可直接插入测试用例

使用方法

1. 输入接口url地址点击发送

2. 点击"AI生成断言"按钮

获取到接口的实时响应后，在响应区可点击AI生成断言按钮

3. 追加定制断言（可选）

在补充输入框描述特殊需求，例如：


"需要验证roles包含admin且token有效期大于当前时间"

点击发送

4. 调整和优化（可选）

可在编辑器内对生成的断言脚本进行调整优化

5. 点击"插入代码"使用

生成的断言脚本会自动添加到当前接口的后执行操作中，脚本名为AI断言

（九）、AI润色文档

Apipost「AI润色文档」功能利用AI能力，对用户输入的文本内容进行智能优化和提升，帮助用户产出更专业、流畅、得体的文本内容。本功能支持多种润色场景和风格需求，适用于各类文档的精细化处理。

Apipost AI一键润色文档

核心价值

✅ 表达优化 - 提升文本流畅度和可读性
✅风格适配 - 适应不同场景和读者群体
✅语法修正 - 自动纠正语法错误和不当用词
✅专业增强 - 提升文本专业性和说服力
✅高效产出 - 快速获得优质文本版本

适用场景

• 接口/目录描述信息的润色

• 单篇Markdown文本内容的优化

  
  

快速开始

1. 在Markdown中输入文本

在接口的详细说明中输入文本，或新建Markdown输入文本内容 

示例原文：

什么是OpenAPI？

OpenAPI是指开放应用程序编程接口（Open Application Programming Interface）的简称。OpenAPI 是指对外提供的、可供开发者进行程序化访问的接口，这个接口可能是针对某个特定的、可能具有专有性质的软件应用程序或网络服务。

API可以视为一层封装，它允许开发人员访问和使用某些功能或数据，而无需了解背后的详细实现，API 文档是API的使用手册，包含如何构建API请求和响应有关的信息。阿里云OpenAPI则是提供给开发者的一系列开放的应用程序接口，使得开发者可以通过这些应用程序接口来管理云上资源、数据和服务等内容。

2. 点击 AI润色按钮

3. 获取润色结果

4. 二次优化（可选）

对润色结果可以选择采纳或者不采纳，在采纳后可以将数据同步至接口编辑器中，在编辑器中对文档可进行手动的修改或者再次润色

常见问题

Q1: 润色后会改变原文核心意思吗？ 

A: 系统会严格保持原文核心信息，仅优化表达方式。用户可通过"保守模式"进一步限制修改幅度。

Q1: 润色后会改变原文核心意思吗？

A：系统会自动识别并保留专业术语。

（十）、AI补全Schema

ApipostAI补全Schema功能通过智能分析JSON数据结构，字段名语义分析，自动为Schema补充字段描述、示例值、默认值等关键信息，显著提升Schema编写效率和数据定义质量。

核心能力

✅智能推断 - 通过字段名和数据结构自动推断语义
✅描述生成 - 自动生成专业准确的字段描述
✅示例补全 - 提供符合业务场景的示例值
✅效率提升 - 减少70%以上的手动输入工作
✅智能推荐 - 基于上下文推荐合适的默认值

适用场景

• 1.API接口文档编写

• 2.数据模型设计

使用步骤

1. 选择一个需要补充的schema

可以对已有的数据结构进行补全，或者新建一个数据结构。 例如新建一个数据结构，导入下方的json：

导入下方的json：

{
"user": {
"id": 1001,
"name": "张三",
"email": "zhangsan@example.com"
 }
}

2. 点击"AI补全"按钮

系统自动生成补全示例值、默认值和字段描述信息。 注意：仅补全为空的信息，如果有数据则跳过

3. 人工校验与调整

·检查自动生成的数据是否准确

·可进行手动的二次修改（可选）

4. 保存补全后的schema

注意：在保存时会有一个选项同步更新补全所有【引用模型】的数据
当模型有引用其他模型时，在AI补全时会一同进行补全，勾选此选项在点击确定保存时，被引用的模型数据也会变更修改；

如果不想修改引用的模型数据，取消勾选即可，这样只会修改当前模型中的字段。

常见问题

Q1: 点击确定后，是否直接保存的数据

A: 如果有引用模型，被引用的模型会被直接保存，而当前模型中的字段需要再次点击「保存模型」或者「保存接口」才会生效

Q2: 如何保证示例值的合理性？

A: 系统会：

• 分析字段名语义

• 参考现有值模式

• 应用行业惯例

• 支持用户手动修正

（十一）、AI智能提取状态码

功能概述

AI智能导入错误码信息功能通过智能识别用户粘贴的错误码文档内容，自动解析提取错误码及其描述信息，快速生成标准化的错误码数据，大幅提升错误码录入效率。

核心价值

✅效率提升：自动解析替代手动录入，节省90%以上时间
✅智能识别：支持多种原始格式的错误码文档
✅标准输出： 统一生成"错误码+描述"的标准格式
✅批量处理：支持一次性导入多个错误码
✅文档集成：自动同步到接口文档状态码字典章节

适用场景

1.从旧文档迁移错误码到新系统

2.从日志/代码注释中提取错误码

3.整理分散的错误码信息

4.快速构建API文档的错误码章节

5.错误码信息的标准化处理

使用步骤

1. 从左侧菜单栏 「项目设置-状态码字典」进入

2. 复制原始错误码信息

从任意来源复制包含错误码的文本：

/*
* 40001: 参数校验失败
* 40002: 用户未认证
* 50001: 系统内部错误 - 数据库连接失败
* 50002: 系统内部错误 - 缓存服务不可用
*/

或非结构化文本：

错误码列表：
- 40400 资源不存在
- 40301 无访问权限(用户角色不符)
- 20000 操作成功

3. 点击"智能导入"并粘贴

将复制的文本粘贴到输入框，点击"智能导入"按钮：

4. 预览解析结果

系统自动识别并格式化输出：

5. 确认导入，点击保存并最终应用

1. 检查自动识别的准确性

2. 调整修改（可选）

3. 点击"保存"同步到接口文档

4. 在文档状态码字段章节查看效果

6、多格式支持

可识别的原始格式包括：

（1）、代码注释格式：

// 40001: 无效的用户ID格式
// 40002: 缺少必填参数

（2）、表格格式：

| 错误码 | 说明 |
|--------|----------------|
| 40401 | 用户不存在 |
| 40301 | 权限不足 |

（3）、日志格式：

[ERROR][CODE:50001] 数据库超时
[WARN][CODE:40003] 请求参数不合法

文档集成效果

在接口文档中自动生成：

常见问题

Q: 是否支持错误码多语言？

A: 支持，可上传多语言版本错误码描述，在解析时可选择目标语言进行解析导入

（十二）、AI搜索

Apipost「AI 搜索」突破传统关键词匹配，支持自然语言描述需求，可全局精准定位相关接口，实现 “想到即搜得” 的智能模糊匹配，简化搜索流程，提升效率。

核心价值

✅ 提效：省去琢磨关键词的时间，快速获取结果。
✅ 精准：理解需求本质，减少结果偏差。
✅ 低门槛：自然语言交互，对新手友好。

适用场景

1️⃣ 模糊检索：当接口过多难以想起精准关键词时，可通过描述核心功能查询，如“找和用户登录有关的接口”“查询短信相关接口”。

2️⃣ 新手引导查询：新成员不了解历史接口命名，可使用场景化提问，如“在做用户登录功能，需要验证身份的接口”“想实现附近推荐，要获取用户位置的接口”。

3️⃣ 批量数据获取：基于功能、场景查询一批相关接口，可明确说明需求范围，如“获取所有和用户身份验证相关的接口”“查找用于消息推送的全部接口”。

使用步骤

1. 点击入口
2. 输入查询需求，例如：与用户相关的接口
3. 查看查询结果，点击后即可定位
4. 重新打开会回显上一次的查询结果，重新搜索则会展示新的搜索结果

常见问题

Q1：为什么我用自然语言描述需求后，没有找到相关接口？

A：可能是由于你的自然语言描述不够清晰、完整，导致系统无法准确理解你的需求。此时，你可以尝试更详细地描述需求，补充更多相关信息，如使用场景、功能细节等。另外，也有可能确实不存在符合该需求的接口，你可以检查需求是否合理或尝试其他表达方式。

Q2：搜索结果较多时，如何快速找到最适合自己的接口？

A：可以进一步用自然语言补充描述自己的需求，缩小搜索范围，以便更快找到最适合的接口。

（十三）、AI生成测试数据

Apipost「AI 生成测试数据」功能，只需一句话描述需求，就能自动生成符合条件的测试数据。彻底改变了手动创建测试数据的繁琐模式，能让测试效率直接提升 80%，助力用户将更多精力投入到核心业务中。

核心价值

✅ 效率跃升：一句话生成数据，测试效率提升 80%。
✅ 减少繁琐：省去手动录入、整理的重复工作。
✅ 聚焦核心：释放精力，专注核心业务测试与优化。

适用场景

1️⃣ 大批量真实数据模拟：支持生成符合业务场景的真实数据。

2️⃣ 接口边界与无效值测试：通过指令生成邮箱边界值、超长字符串等数据，全面检测接口稳定性。

3️⃣ 国际化测试数据生成：快速生成适配多语言、多地区的测试数据，验证全球化功能。

4️⃣ 数据库防注入测试：使用 “生成10条包含单 / 双引号、分号、注释符等特殊字符的数据” 指令，模拟恶意注入，排查数据库安全隐患。

使用步骤

• 进入「自动化测试」——选择「用例」——点击「测试数据」——选择「新建」

• 可先添加"列"名，或直接点击「AI生成」来创建 "列"

• 输入数据需求，或点击常用关键词，指令结构参考如下：

“帮我生成 10 条，包含边界值，以及特殊符号的测试数据”

1. 查看展示的生成数据，可删除不需要的数据，点击采纳即可追加到页面中，采纳后可对测试数据进行二次编辑修改。

测试数据的使用：参考Apipost官方使用文档：

https://wiki.apipost.cn/docs/test/test-data/

常见问题

Q1：生成的测试数据不符合需求怎么办？

A: 可能是由于需求描述不够清晰、具体导致的。此时，用户可以更详细地补充需求信息，如明确数据的格式要求、范围限制等，重新发起生成指令。

Q2: 一次最多能生成多少条测试数据？ 

A: 目前该功能一次最多可生成 50 条测试数据。若有更大批量的数据需求，可分多次生成，后续我们会根据用户反馈考虑扩展生成数量上限。

Q3：生成的测试数据会涉及隐私信息吗？ 

A: 不会，生成的均为不含敏感内容的模拟数据。

五、快速上手Apipost丝滑体验

1.发送一个接口请求

利用Apipost调试接口，并快速生成接口文档，让您初步体验Apipost的魅力！

新建接口

我想模拟发送请求如下

curl格式代码
curl --location --request POST 'https://echo.Apipost.cn/get.php?c=Course&id=1000' \
--header 'User-Agent: Apipost client Runtime/+https://www.Apipost.cn/' \
--header 'Content-Type: application/json' \
--data '{
 "course_id":1
}'

• 进入Apipost，新建接口，选择「cURL导入」

• 将curl代码粘贴至弹窗内，点击「导入」

• 导入接口后，也可修改接口入参

• 点击「发送」，查看接口返回结果：

可以查看返回数据，返回Header、Cookie、状态码、请求时长等等数据。

将返回结果保存为响应示例:

2、点击分享文档

保存接口，点击「分享」

复制并打开文档地址就可以看到了完整的接口文档。

通过以上一个接口文档的创建过程，可以明显体会到Apipost在生成优雅美观文档的同时，还大大节省了前、后端的开发以及沟通时间。除此之外，Apipost还有更多更好的功能等您来体验。

Apipost免费下载使用：

https://www.apipost.cn/download.html