diff --git a/development/dev-api/index.html b/development/dev-api/index.html index 51333588..9ff1b2cb 100644 --- a/development/dev-api/index.html +++ b/development/dev-api/index.html @@ -582,52 +582,45 @@ - - - -
  • - - 运行测试用例 + 调用方法说明 +
  • @@ -643,7 +636,7 @@
  • - + 返回详细测试结果数据 @@ -772,52 +765,45 @@ - -
  • - -
  • - - 运行测试用例 + 调用方法说明 +
  • @@ -833,7 +819,7 @@
  • - + 返回详细测试结果数据 @@ -867,46 +853,41 @@

    HttpRunner 除了作为命令行工具使用外,还可以作为软件包集成到你自己的项目中。

    简单来说,HttpRunner 提供了运行 YAML/JSON 格式测试用例的能力,并能返回详细的测试结果信息。

    HttpRunner class

    -

    HttpRunner 以 类(class) 的形式对外提供调用支持,类名为HttpRunner,导入方式如下:

    +

    TL;DR

    +

    HttpRunner 以 类(class) 的形式对外提供调用支持,类名为HttpRunner。使用方式如下:

    from httprunner.api import HttpRunner
    +
    +runner = HttpRunner(
    +    failfast=True,
    +    save_tests=True,
    +    log_level="INFO",
    +    log_file="test.log"
    +)
    +summary = runner.run(path_or_tests)
     
    -

    可用初始化参数

    -

    HttpRunner 内部用于驱动测试执行的是 unittest.TextTestRunner,在初始化 HttpRunner 时可以使用 TextTestRunner 的所有可用参数(详情可阅读官方文档)。除此之外,HttpRunner还额外支持一个参数,http_client_session,可用于指定不同的客户端类型。

    -

    通常情况下,初始化 HttpRunner 时常用的参数有如下几个:

    +

    初始化参数说明

    +

    通常情况下,初始化 HttpRunner 时的参数有如下几个:

    -

    例如,如需初始化 HttpRunner 时设置 failfast 为 False,初始化方式如下所示:

    -
    from httprunner.api import HttpRunner
    -
    -runner = HttpRunner(failfast=False)
    -
    - - -

    可用调用方法

    -

    HttpRunner 中,对外提供了两个方法:

    +

    调用方法说明

    +

    HttpRunner 中,对外提供了一个 run 方法,用于运行测试用例。

    +

    run 方法有三个参数: