3.9 KiB
3.9 KiB
合规性验证工具使用手册
1. 用户注册与登录
为了保证测试环境的隔离和安全，所有操作都需要在登录后进行。
1.1 注册
首次访问时，您将被重定向到登录页面。点击 "点此注册" 链接进入注册页面。
输入您想要的用户名和密码，然后点击 "注册" 按钮。如果用户名未被占用，系统将提示您 "注册成功! 请登录." 并跳转回登录页面。
1.2 登录
在登录页面，输入您刚刚注册的用户名和密码，点击 "登录"。
登录成功后，您将看到应用的主界面。
2. 主界面功能介绍
应用的主界面是您配置和发起测试的核心区域。
2.1 API 规范配置
这是进行测试的首要步骤。
- API 规范类型: 选择您的 API 定义文件类型，是 YAPI 还是 Swagger/OpenAPI。
- YAPI/Swagger 文件路径:
- 输入 API 规范文件在 服务器上 的 绝对路径 或 相对于
flask_app.py的相对路径。 - 例如，如果文件在
/data/specs/my_api.json，则输入该绝对路径。 - 如果文件在项目根目录下的
assets/doc/api.json，可以输入assets/doc/api.json。
- 输入 API 规范文件在 服务器上 的 绝对路径 或 相对于
- 加载分类/标签: 输入文件路径后，点击此按钮。系统会解析文件，并在下方列出文件中定义的所有 API 分类（YAPI）或标签（Swagger），供您查阅。
2.2 基本配置
- 目标服务 Base URL: 输入您要测试的 API 服务的基础地址。例如
http://api.example.com/v1。框架会将此 URL 与 API 规范中的相对路径拼接成完整的请求地址。
2.3 高级配置 (可折叠)
点击 "高级配置" 标题可以展开或收起以下选项，这些选项都有预设的默认值。
- 自定义测试用例目录: 指向包含自定义测试用例（
BaseAPITestCase的子类）的文件夹路径。 - 自定义阶段目录: 指向包含自定义测试阶段（
BaseAPIStage的子类）的文件夹路径。 - 报告输出目录: 指定生成的测试报告（JSON 摘要和 Markdown 详情）要保存到的目录。
默认值分别为 ./custom_testcases, ./custom_stages, 和 ./test_reports。
2.4 LLM 配置 (可折叠)
点击 "LLM 配置" 标题可以展开或收起此部分。这些配置用于启用和控制使用大语言模型（LLM）生成测试数据的功能。
- LLM API Key: 您的 LLM 服务提供商的 API 密钥。
- LLM Base URL: 您的 LLM 服务的 API 地址。
- LLM 模型名称: 您要使用的具体模型名称。
- 使用 LLM 生成...: 勾选相应的复选框，可以启用 LLM 来自动生成请求体、路径参数、查询参数或请求头。
3. 执行测试与查看结果
配置完成后，点击页面底部的 "运行测试" 按钮。
- 日志输出: 测试过程中的实时日志会显示在此文本框中。
- 测试摘要: 测试完成后，此处会显示一个总结性的表格，包含成功、失败、总计等信息。
- 报告链接:
- 摘要报告 (JSON): 点击链接可以查看详细的 JSON 格式测试摘要。
- API 调用详情 (Markdown): 点击链接可以下载一个 Markdown 格式的报告，其中包含了每一次 API 调用的详细信息（请求头、请求体、响应头、响应体、cURL 命令等），并且每个条目都是可折叠的，方便查阅。
4. 查看报告详情
下载的 "API 调用详情 (Markdown)" 文件，可以使用任何支持 Markdown 的编辑器（如 VS Code, Typora）打开，以获得最佳的阅读体验。
报告中的每个 API 调用都是一个独立的、可折叠的部分，您可以轻松地展开您关心的失败或成功的请求，查看其所有细节。