diff --git a/README.md b/README.md index 4b0c571..d20cea1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ -# apitest +# Apitest -**apitest** is a declartive api testing tool. +Apitest is a declartive api testing tool. +Read this in other languages: [中文](./README.zh-CN.md) -- [apitest](#apitest) +- [Apitest](#apitest) - [Introduction](#introduction) - [Installation](#installation) - [Features](#features) @@ -27,16 +28,11 @@ - [Normal Mode](#normal-mode) - [CI Mode](#ci-mode) -[中文文档](./README.zh-CN.md) - ## Introduction ``` apitest examples/realworld -``` -command output: -``` module main prepare ✔ module auth diff --git a/README.zh-CN.md b/README.zh-CN.md index 4758b0b..083373a 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,26 +1,28 @@ -# apitest +# Apitest Apitest 是一款接口自动化测试工具。 -- [apitest](#apitest) +其他语言版本: [English](./README.md) + +- [Apitest](#apitest) - [介绍](#介绍) - [安装](#安装) - [特性](#特性) - - [类json的DSL描述测试用例](#类json的dsl描述测试用例) + - [类JSON的DSL编写用例](#类json的dsl编写用例) - [跨平台,跨编程语言](#跨平台跨编程语言) - [支持Mock](#支持mock) - - [数据自身就是断言](#数据自身就是断言) - - [数据皆变量](#数据皆变量) - - [巧用 Mixin,摆脱复制粘贴](#巧用-mixin摆脱复制粘贴) - - [CI 支持](#ci-支持) - - [tdd 支持](#tdd-支持) - - [自定义函数](#自定义函数) + - [数据即断言](#数据即断言) + - [数据即变量](#数据即变量) + - [支持Mixin](#支持mixin) + - [支持CI](#支持ci) + - [支持TDD](#支持tdd) + - [用户定义函数](#用户定义函数) - [注解](#注解) - [入口文件注解](#入口文件注解) - [用例注解](#用例注解) - [客户端](#客户端) - - [echo](#echo) - - [http](#http) + - [Echo](#echo) + - [Http](#http) - [命令行](#命令行) - [多测试环境](#多测试环境) - [常规模式](#常规模式) @@ -85,7 +87,7 @@ Apitest工具是单可执行文件,不需要安装,放到`PATH`路径下面 ## 特性 -### 类json的DSL描述测试用例 +### 类JSON的DSL编写用例 测试用例本身就可以作为接口使用的辅助参考文档。 @@ -154,7 +156,7 @@ Apitest 支持近40个mock函数。详细清单见[sigodne/fake.js](https://gith > Apitest 使用的是自己的mock库(参考了mock.js),mock函数很自由添加的。有想要的mock欢迎提交issue。 -### 数据自身就是断言 +### 数据即断言 这句话有点绕,下面举例说明下。 @@ -211,7 +213,7 @@ Apitest 支持近40个mock函数。详细清单见[sigodne/fake.js](https://gith 我们还是校验了所有的字段。因为`token`和`expireIn`值是变的,我们使用`@type`告诉 Apitest 只校验字段的类型,而忽略具体的值。 - ### 数据皆变量 + ### 数据即变量 后面的测试用例可以使用前面测试用例的数据的所有数据。 @@ -240,7 +242,9 @@ Apitest 支持近40个mock函数。详细清单见[sigodne/fake.js](https://gith } ``` -### 巧用 Mixin,摆脱复制粘贴 +### 支持Mixin + +巧用 Mixin,摆脱复制粘贴 一般一个接口不会只被一个用例用到吧。我们可以把路由抽离到 mixin 中,避免每个用例都需要复制一遍路由信息。 @@ -284,11 +288,11 @@ Apitest 支持近40个mock函数。详细清单见[sigodne/fake.js](https://gith 你get到了吗? -### CI 支持 +### 支持CI 本身作为一款命令行工具,就十分容易和后端的ci集成在一起。而且 apitest 还提供了`--ci`选项专门就ci做了优化。 -### tdd 支持 +### 支持TDD 用例就是json,所有你可以分分钟编写,这就十分有利于 tdd 了。 @@ -300,11 +304,11 @@ Apitest 支持近40个mock函数。详细清单见[sigodne/fake.js](https://gith tdd! tdd! tdd! -### 自定义函数 +### 用户定义函数 这个功能你根本不需要用到。但我还是担心在某些极限或边角的场景下需要,所以还是支持了。 -Apitest 允许用户通过 js 编写自定义函数构造请求数据或校验响应数据。(还敢号称跨编程语言吗?🐶) +Apitest 允许用户通过 js 编写用户定义函数构造请求数据或校验响应数据。(还敢号称跨编程语言吗?🐶) 编写函数`lib.js` ```js @@ -352,7 +356,7 @@ function isDate(date) { Apitest 使用JSONA格式描述测试用例。 -JSONA其实就是JSON,松了一些语法限制(不强制要求双引号,支持注释等),再添加了一个特性:注解。即 JSONA = JSON + Annotation(注解)。 +JSONA其实就是JSON,松了一些语法限制(不强制要求双引号,支持注释等),再添加了一个特性:注解。即 JSONA = JSON + 注解。 JSON描述数据,注解描述逻辑。 @@ -446,7 +450,7 @@ JSON描述数据,注解描述逻辑。 Apitest 提供两种客户端。 -### echo +### Echo `echo`客户端不发出任何请求,直接把`req`部分的数据原样返回作为`res`数据。 @@ -461,7 +465,7 @@ Apitest 提供两种客户端。 } ``` -### http +### Http `http`客户端处理http/https请求响应。