From d56a8ea219c074dc46d0bd58b1fc694727049d3e Mon Sep 17 00:00:00 2001 From: debugtalk Date: Sun, 23 Jul 2017 21:50:44 +0800 Subject: [PATCH] update docs --- README.md | 25 ++++++++++++++----------- docs/feature-descriptions-CN.md | 11 +++++++++++ 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fea1ded0..d40b95e8 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,20 @@ ## Design Philosophy -Take full reuse of Python's existing powerful libraries: [`requests`][requests], [`unittest`][unittest] and [`Locust`][Locust]. And achieve the goal of API automation test, production environment monitoring, and API performance test, with a concise and elegant manner. +Take full reuse of Python's existing powerful libraries: [`Requests`][requests], [`unittest`][unittest] and [`Locust`][Locust]. And achieve the goal of API automation test, production environment monitoring, and API performance test, with a concise and elegant manner. ## Key Features -- 支持API接口的多种请求方法，包括 GET/POST/HEAD/PUT/DELETE 等 -- 测试用例与代码分离，测试用例维护方式简洁优雅，支持`YAML/JSON` -- 测试用例描述方式具有表现力，可采用简洁的方式描述输入参数和预期输出结果 -- 接口测试用例具有可复用性，便于创建复杂测试场景 -- 测试执行方式简单灵活，支持单接口调用测试、批量接口调用测试、定时任务执行测试 -- 测试结果统计报告简洁清晰，附带详尽日志记录，包括接口请求耗时、请求响应数据等 -- 身兼多职，同时实现接口管理、接口自动化测试、接口性能测试（结合Locust） -- 具有可扩展性，便于扩展实现Web平台化 +- Inherit all powerful features of [`Requests`][requests], just have fun to handle HTTP in human way. +- Define testcases in YAML or JSON format in concise and elegant manner. +- Supports `function`/`variable`/`extract`/`validate` mechanisms to create full test scenarios. +- Testcases can be run in diverse ways, with single testset, multiple testsets, or whole project folder. +- Test report is concise and clear, with detailed log records. See [`PyUnitReport`][PyUnitReport]. +- Perfect combination with [Jenkins][Jenkins], running continuous test and production monitoring. +- With reuse of [`Locust`][Locust], you can run performance test without extra work. +- It is extensible to facilitate the implementation of web platform with [`Flask`][flask] framework. -[*`Background Introduction (CN)`*](docs/background-CN.md) | [*`Feature Descriptions (CN)`*](docs/feature-descriptions-CN.md) +[*`Background Introduction (中文版)`*](docs/background-CN.md) | [*`Feature Descriptions (中文版)`*](docs/feature-descriptions-CN.md) ## Installation @@ -144,7 +144,7 @@ $ ate testcases_folder_path Python `2.7`, `3.3`, `3.4`, `3.5`, and `3.6`. -## To Learn more ... +## To learn more ... - [《接口自动化测试的最佳工程实践（ApiTestEngine）》](http://debugtalk.com/post/ApiTestEngine-api-test-best-practice/) - [《ApiTestEngine 演进之路（0）开发未动，测试先行》](http://debugtalk.com/post/ApiTestEngine-0-setup-CI-test/) @@ -157,3 +157,6 @@ Python `2.7`, `3.3`, `3.4`, `3.5`, and `3.6`. [requests]: http://docs.python-requests.org/en/master/ [unittest]: https://docs.python.org/3/library/unittest.html [Locust]: http://locust.io/ +[flask]: http://flask.pocoo.org/ +[PyUnitReport]: https://github.com/debugtalk/PyUnitReport +[Jenkins]: https://jenkins.io/index.html \ No newline at end of file diff --git a/docs/feature-descriptions-CN.md b/docs/feature-descriptions-CN.md index 11b96b4d..c4dbdb70 100644 --- a/docs/feature-descriptions-CN.md +++ b/docs/feature-descriptions-CN.md @@ -1,3 +1,14 @@ +## 核心特性 + +- 支持API接口的多种请求方法，包括 GET/POST/HEAD/PUT/DELETE 等 +- 测试用例与代码分离，测试用例维护方式简洁优雅，支持`YAML/JSON` +- 测试用例描述方式具有表现力，可采用简洁的方式描述输入参数和预期输出结果 +- 接口测试用例具有可复用性，便于创建复杂测试场景 +- 测试执行方式简单灵活，支持单接口调用测试、批量接口调用测试、定时任务执行测试 +- 测试结果统计报告简洁清晰，附带详尽日志记录，包括接口请求耗时、请求响应数据等 +- 身兼多职，同时实现接口管理、接口自动化测试、接口性能测试（结合Locust） +- 具有可扩展性，便于扩展实现Web平台化 + ## 特性拆解介绍 > 支持API接口的多种请求方法，包括 GET/POST/HEAD/PUT/DELETE 等