From 5be6c2bb2c3b95ae11dafb9b9d8fd3ad4dfce889 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Wed, 11 Dec 2019 17:14:13 +0800 Subject: [PATCH] docs: update --- docs/examples/{test_klook => demo-klook}/README.md | 14 +++++++++++--- .../{test_klook => demo-klook}/__init__.py | 0 .../api/find_place_api.yml | 0 .../api/get_area_groups_api.yml | 0 .../api/place_detail_api.yml | 0 .../api/search_area_by_name_api.yml | 0 .../data/place_detail.csv | 0 .../{test_klook => demo-klook}/debugtalk.py | 0 .../testcases/find_place_testcase.yml | 0 .../testcases/get_area_groups_testcase.yml | 0 .../testcases/just_request_testcase.yml | 0 .../testcases/place_detail_testcase.yml | 0 .../testcases/search_area_by_name_api_testcase.yml | 0 .../testsuites/area_manage_testsuite.yml | 0 .../testsuites/place_detail_testsuite.yml | 0 .../{test_klook => demo-klook}/utils/__init__.py | 0 .../utils/setup_hooks.py | 0 .../utils/teardown_hooks.py | 0 .../utils/validators/validators_of_area.py | 0 .../utils/validators/validators_of_common.py | 0 mkdocs.yml | 1 + 21 files changed, 12 insertions(+), 3 deletions(-) rename docs/examples/{test_klook => demo-klook}/README.md (80%) rename docs/examples/{test_klook => demo-klook}/__init__.py (100%) rename docs/examples/{test_klook => demo-klook}/api/find_place_api.yml (100%) rename docs/examples/{test_klook => demo-klook}/api/get_area_groups_api.yml (100%) rename docs/examples/{test_klook => demo-klook}/api/place_detail_api.yml (100%) rename docs/examples/{test_klook => demo-klook}/api/search_area_by_name_api.yml (100%) rename docs/examples/{test_klook => demo-klook}/data/place_detail.csv (100%) rename docs/examples/{test_klook => demo-klook}/debugtalk.py (100%) rename docs/examples/{test_klook => demo-klook}/testcases/find_place_testcase.yml (100%) rename docs/examples/{test_klook => demo-klook}/testcases/get_area_groups_testcase.yml (100%) rename docs/examples/{test_klook => demo-klook}/testcases/just_request_testcase.yml (100%) rename docs/examples/{test_klook => demo-klook}/testcases/place_detail_testcase.yml (100%) rename docs/examples/{test_klook => demo-klook}/testcases/search_area_by_name_api_testcase.yml (100%) rename docs/examples/{test_klook => demo-klook}/testsuites/area_manage_testsuite.yml (100%) rename docs/examples/{test_klook => demo-klook}/testsuites/place_detail_testsuite.yml (100%) rename docs/examples/{test_klook => demo-klook}/utils/__init__.py (100%) rename docs/examples/{test_klook => demo-klook}/utils/setup_hooks.py (100%) rename docs/examples/{test_klook => demo-klook}/utils/teardown_hooks.py (100%) rename docs/examples/{test_klook => demo-klook}/utils/validators/validators_of_area.py (100%) rename docs/examples/{test_klook => demo-klook}/utils/validators/validators_of_common.py (100%) diff --git a/docs/examples/test_klook/README.md b/docs/examples/demo-klook/README.md similarity index 80% rename from docs/examples/test_klook/README.md rename to docs/examples/demo-klook/README.md index 80c07e3a..b178defd 100644 --- a/docs/examples/test_klook/README.md +++ b/docs/examples/demo-klook/README.md @@ -1,11 +1,17 @@ ## 案例介绍 -我们团队在调研接口测试框架的时候选了httprunner，[让我](https://github.com/readyou)来负责给大家做一次分享，于是有了这里的示例。 + +- 被测案例：[klook](https://www.klook.com/) +- 案例作者：[readyou](https://github.com/readyou) + +我们团队选择了 HttpRunner 作为接口测试框架，并整理了一份案例，供大家参考。 ## 注意事项 -1. 本例子中有些地方用到了`localhost:8085`作为base_url，这些接口是不能访问的，仅仅作为示例学习怎样组织测试用例。 + +1. 本例子中有些地方用到了`localhost:8085`作为base_url，这些接口是不能访问的，仅作为示例学习怎样组织测试用例。 2. `https://maps.googleapis.com`是可以用的，自己申请一个key，替换掉文件中的`your_google_map_key`即可。 ## 相关文件说明 + 模块 | 文件 | 用途 | 备注 ---|----|------|------ google map 接口测试 | api/find_place_api.yml | google map根据名称搜索地址的api | 比较全面地使用了api可以使用的关键字：name, base_url, request, variables, validate, extract @@ -19,4 +25,6 @@ klook地理位置搜索接口测试 | api/get_area_groups_api.yml | 查询地理 klook地理位置搜索接口测试 | api/get_area_groups_testcase.yml | 查询地理位置下面的组——testcase | klook地理位置搜索接口测试 | api/area_manage_testsuite.yml | 区域管理——testsuite | | | -baidu首页demo | testcases/just_request_testcase.yml | 提取百度首页title的demo | 演示了直接使用request而不是引用api的方式，使用了teardown_hooks的使用 \ No newline at end of file +baidu首页demo | testcases/just_request_testcase.yml | 提取百度首页title的demo | 演示了直接使用request而不是引用api的方式，使用了teardown_hooks的使用 + +完整的案例访问[地址](https://github.com/httprunner/httprunner/tree/master/docs/examples/demo-klook)。 diff --git a/docs/examples/test_klook/__init__.py b/docs/examples/demo-klook/__init__.py similarity index 100% rename from docs/examples/test_klook/__init__.py rename to docs/examples/demo-klook/__init__.py diff --git a/docs/examples/test_klook/api/find_place_api.yml b/docs/examples/demo-klook/api/find_place_api.yml similarity index 100% rename from docs/examples/test_klook/api/find_place_api.yml rename to docs/examples/demo-klook/api/find_place_api.yml diff --git a/docs/examples/test_klook/api/get_area_groups_api.yml b/docs/examples/demo-klook/api/get_area_groups_api.yml similarity index 100% rename from docs/examples/test_klook/api/get_area_groups_api.yml rename to docs/examples/demo-klook/api/get_area_groups_api.yml diff --git a/docs/examples/test_klook/api/place_detail_api.yml b/docs/examples/demo-klook/api/place_detail_api.yml similarity index 100% rename from docs/examples/test_klook/api/place_detail_api.yml rename to docs/examples/demo-klook/api/place_detail_api.yml diff --git a/docs/examples/test_klook/api/search_area_by_name_api.yml b/docs/examples/demo-klook/api/search_area_by_name_api.yml similarity index 100% rename from docs/examples/test_klook/api/search_area_by_name_api.yml rename to docs/examples/demo-klook/api/search_area_by_name_api.yml diff --git a/docs/examples/test_klook/data/place_detail.csv b/docs/examples/demo-klook/data/place_detail.csv similarity index 100% rename from docs/examples/test_klook/data/place_detail.csv rename to docs/examples/demo-klook/data/place_detail.csv diff --git a/docs/examples/test_klook/debugtalk.py b/docs/examples/demo-klook/debugtalk.py similarity index 100% rename from docs/examples/test_klook/debugtalk.py rename to docs/examples/demo-klook/debugtalk.py diff --git a/docs/examples/test_klook/testcases/find_place_testcase.yml b/docs/examples/demo-klook/testcases/find_place_testcase.yml similarity index 100% rename from docs/examples/test_klook/testcases/find_place_testcase.yml rename to docs/examples/demo-klook/testcases/find_place_testcase.yml diff --git a/docs/examples/test_klook/testcases/get_area_groups_testcase.yml b/docs/examples/demo-klook/testcases/get_area_groups_testcase.yml similarity index 100% rename from docs/examples/test_klook/testcases/get_area_groups_testcase.yml rename to docs/examples/demo-klook/testcases/get_area_groups_testcase.yml diff --git a/docs/examples/test_klook/testcases/just_request_testcase.yml b/docs/examples/demo-klook/testcases/just_request_testcase.yml similarity index 100% rename from docs/examples/test_klook/testcases/just_request_testcase.yml rename to docs/examples/demo-klook/testcases/just_request_testcase.yml diff --git a/docs/examples/test_klook/testcases/place_detail_testcase.yml b/docs/examples/demo-klook/testcases/place_detail_testcase.yml similarity index 100% rename from docs/examples/test_klook/testcases/place_detail_testcase.yml rename to docs/examples/demo-klook/testcases/place_detail_testcase.yml diff --git a/docs/examples/test_klook/testcases/search_area_by_name_api_testcase.yml b/docs/examples/demo-klook/testcases/search_area_by_name_api_testcase.yml similarity index 100% rename from docs/examples/test_klook/testcases/search_area_by_name_api_testcase.yml rename to docs/examples/demo-klook/testcases/search_area_by_name_api_testcase.yml diff --git a/docs/examples/test_klook/testsuites/area_manage_testsuite.yml b/docs/examples/demo-klook/testsuites/area_manage_testsuite.yml similarity index 100% rename from docs/examples/test_klook/testsuites/area_manage_testsuite.yml rename to docs/examples/demo-klook/testsuites/area_manage_testsuite.yml diff --git a/docs/examples/test_klook/testsuites/place_detail_testsuite.yml b/docs/examples/demo-klook/testsuites/place_detail_testsuite.yml similarity index 100% rename from docs/examples/test_klook/testsuites/place_detail_testsuite.yml rename to docs/examples/demo-klook/testsuites/place_detail_testsuite.yml diff --git a/docs/examples/test_klook/utils/__init__.py b/docs/examples/demo-klook/utils/__init__.py similarity index 100% rename from docs/examples/test_klook/utils/__init__.py rename to docs/examples/demo-klook/utils/__init__.py diff --git a/docs/examples/test_klook/utils/setup_hooks.py b/docs/examples/demo-klook/utils/setup_hooks.py similarity index 100% rename from docs/examples/test_klook/utils/setup_hooks.py rename to docs/examples/demo-klook/utils/setup_hooks.py diff --git a/docs/examples/test_klook/utils/teardown_hooks.py b/docs/examples/demo-klook/utils/teardown_hooks.py similarity index 100% rename from docs/examples/test_klook/utils/teardown_hooks.py rename to docs/examples/demo-klook/utils/teardown_hooks.py diff --git a/docs/examples/test_klook/utils/validators/validators_of_area.py b/docs/examples/demo-klook/utils/validators/validators_of_area.py similarity index 100% rename from docs/examples/test_klook/utils/validators/validators_of_area.py rename to docs/examples/demo-klook/utils/validators/validators_of_area.py diff --git a/docs/examples/test_klook/utils/validators/validators_of_common.py b/docs/examples/demo-klook/utils/validators/validators_of_common.py similarity index 100% rename from docs/examples/test_klook/utils/validators/validators_of_common.py rename to docs/examples/demo-klook/utils/validators/validators_of_common.py diff --git a/mkdocs.yml b/mkdocs.yml index 561fdd97..e73dea8b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -74,6 +74,7 @@ nav: - FAQ: FAQ.md - 实践案例: - TesterHome 登录: examples/testerhome-login.md + - klook: examples/demo-klook/README.md - 相关资料: related-docs.md - CHANGELOG: CHANGELOG.md