chore: update readme & add community-related (#394)
Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
This commit is contained in:
YuLuo
GitHub
parent
9156fb85a4
commit
02dd80fee0
|
|
@ -0,0 +1,138 @@
|
|||
[](https://cla-assistant.io/LinuxSuRen/api-testing)
|
||||
[](https://app.codacy.com/gh/LinuxSuRen/api-testing/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
||||
[](https://app.codacy.com/gh/LinuxSuRen/api-testing/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
||||
[](https://tooomm.github.io/github-release-stats/?username=linuxsuren&repository=api-testing)
|
||||
[](https://hub.docker.com/r/linuxsuren/api-testing)
|
||||
[](https://github.com/LinuxSuRen/open-source-best-practice)
|
||||
|
||||
一个开源的 API 测试工具。🚀
|
||||
|
||||
## 功能特性
|
||||
|
||||
* 支持的协议: HTTP, gRPC, tRPC
|
||||
* 支持多种格式的测试结果导出: Markdown, HTML, PDF, Stdout
|
||||
* 通过简单配置模拟服务
|
||||
* 支持转换为 [JMeter](https://jmeter.apache.org/) 文件格式
|
||||
* 支持响应体字段检查或 [eval](https://expr.medv.io/)
|
||||
* 使用 [JSON schema] 校验响应参数(https://json-schema.org/)
|
||||
* 支持预处理和后处理 API 请求
|
||||
* 支持以服务器模式运行并支持 [gRPC](pkg/server/server.proto) 和 HTTP endpoint
|
||||
* [VS Code 扩展支持](https://github.com/LinuxSuRen/vscode-api-testing)
|
||||
* [Github 扩展支持](https://github.com/marketplace/actions/api-testing-with-kubernetes)
|
||||
* 支持多种存储方式 (Local, ORM Database, S3, Git, Etcd, etc.)
|
||||
* [HTTP API record](https://github.com/LinuxSuRen/atest-ext-collector)
|
||||
* 支持多种安装方式(CLI, Container, Native-Service, Operator, Helm, etc.)
|
||||
* 整合 Prometheus, SkyWalking 监控
|
||||
|
||||
## 快速开始
|
||||
|
||||
[](https://zeabur.com?referralCode=LinuxSuRen&utm_source=LinuxSuRen&utm_campaign=oss) [](http://play-with-docker.com?stack=https://raw.githubusercontent.com/LinuxSuRen/api-testing/master/docs/manifests/docker-compose.yml)
|
||||
|
||||
通过 [hd](https://github.com/LinuxSuRen/http-downloader) 安装，或从 [releases](https://github.com/LinuxSuRen/api-testing/releases) 下载安装:
|
||||
|
||||
```shell
|
||||
hd install atest
|
||||
```
|
||||
|
||||
您也可以通过 kubernetes 安装，更多细节请参考： [manifests](docs/manifests/kubernetes/default/manifest.yaml).
|
||||
|
||||
用法如下：
|
||||
|
||||
```shell
|
||||
API testing tool
|
||||
|
||||
Usage:
|
||||
atest [command]
|
||||
|
||||
Available Commands:
|
||||
completion Generate the autocompletion script for the specified shell
|
||||
func Print all the supported functions
|
||||
help Help about any command
|
||||
json Print the JSON schema of the test suites struct
|
||||
run Run the test suite
|
||||
sample Generate a sample test case YAML file
|
||||
server Run as a server mode
|
||||
service Install atest as a Linux service
|
||||
|
||||
Flags:
|
||||
-h, --help help for atest
|
||||
-v, --version version for atest
|
||||
|
||||
Use "atest [command] --help" for more information about a command.
|
||||
```
|
||||
|
||||
API Testing 使用示例，在此示例中，您将通过 md 格式阅览生成的接口测试报告：
|
||||
|
||||
`atest run -p sample/testsuite-gitlab.yaml --duration 1m --thread 3 --report md`
|
||||
|
||||
| API | Average | Max | Min | Count | Error |
|
||||
|---|---|---|---|---|---|
|
||||
| GET https://gitlab.com/api/v4/projects | 1.152777167s | 2.108680194s | 814.928496ms | 99 | 0 |
|
||||
| GET https://gitlab.com/api/v4/projects/45088772 | 840.761064ms | 1.487285371s | 492.583066ms | 10 | 0 |
|
||||
consume: 1m2.153686448s
|
||||
|
||||
## 在 Docker 中使用
|
||||
|
||||
在 Docker 中以服务器模式运行 `atest`，您可以通过 `8080` 访问 `atest` 的 UI 控制台：
|
||||
|
||||
```bash
|
||||
docker run --pull always -p 8080:8080 ghcr.io/linuxsuren/api-testing:master
|
||||
```
|
||||
|
||||
在 Docker 中使用 `atest-collector`:
|
||||
|
||||
```shell
|
||||
docker run -p 1234:8080 -v /var/tmp:/var/tmp \
|
||||
ghcr.io/linuxsuren/api-testing atest-collector \
|
||||
--filter-path /api \
|
||||
-o /var/tmp/sample.yaml
|
||||
# you could find the test cases file from /var/tmp/sample
|
||||
# cat /var/tmp/sample
|
||||
```
|
||||
|
||||
## 模板
|
||||
|
||||
以下字段的模板配置参考：[sprig](http://masterminds.github.io/sprig/):
|
||||
|
||||
* API
|
||||
* Request Body
|
||||
* Request Header
|
||||
|
||||
### Functions
|
||||
|
||||
您可以使用 [sprig](http://masterminds.github.io/sprig/) 中的所有常用函数。此外，还有一些特殊函数可以在 `atest` 中使用：
|
||||
|
||||
| Name | Usage |
|
||||
|---|---|
|
||||
| `randomKubernetesName` | `{{randomKubernetesName}}` to generate Kubernetes resource name randomly, the name will have 8 chars |
|
||||
| `sleep` | `{{sleep(1)}}` in the pre and post request handle |
|
||||
|
||||
## 验证 Kuberntes 资源
|
||||
|
||||
`atest` 可以验证任何类型的 Kubernetes 资源。使用前请先设置 Kubernetes 相关的环境变量：
|
||||
|
||||
* `KUBERNETES_SERVER`
|
||||
* `KUBERNETES_TOKEN`
|
||||
|
||||
另请参考 [example](sample/kubernetes.yaml)。
|
||||
|
||||
## 待办事项
|
||||
|
||||
* 减少上下文的大小
|
||||
* 支持自定义上下文
|
||||
|
||||
## 功能限制
|
||||
|
||||
* 仅支持解析 map 或 array 类型的响应体。
|
||||
|
||||
## 社区交流
|
||||
|
||||
欢迎使用以下联系方式，探讨有关 API Testing 的任何问题！
|
||||
|
||||
### 邮件列表
|
||||
|
||||
`api-testing-tech@googlegroups.com`, 欢迎通过此邮件列表讨论与 API Testing 相关的任何问题。
|
||||
|
||||
### Githbu Discussion
|
||||
|
||||
[Github Discussion](https://github.com/LinuxSuRen/api-testing/discussions/new/choose)
|
||||
62
README.md
62
README.md
|
|
@ -5,23 +5,23 @@
|
|||
[](https://hub.docker.com/r/linuxsuren/api-testing)
|
||||
[](https://github.com/LinuxSuRen/open-source-best-practice)
|
||||
|
||||
This is a API testing tool.
|
||||
This is a API testing tool. 🚀
|
||||
|
||||
## Features
|
||||
|
||||
* Supported protocols: HTTP, gRPC, tRPC
|
||||
* Multiple test report formats: Markdown, HTML, PDF, Stdout
|
||||
* Mock Server in simple configuration
|
||||
* Support converting to [JMeter](https://jmeter.apache.org/) files
|
||||
* Response Body fields equation check or [eval](https://expr.medv.io/)
|
||||
* Validate the response body with [JSON schema](https://json-schema.org/)
|
||||
* Pre and post handle with the API request
|
||||
* Run in server mode, and provide the [gRPC](pkg/server/server.proto) and HTTP endpoint
|
||||
* [VS Code extension](https://github.com/LinuxSuRen/vscode-api-testing) support
|
||||
* Multiple storage backends supported(Local, ORM Database, S3, Git, Etcd, etc.)
|
||||
* [HTTP API record](https://github.com/LinuxSuRen/atest-ext-collector)
|
||||
* Install in multiple use cases(CLI, Container, Native-Service, Operator, Helm, etc.)
|
||||
* Monitoring integration with Prometheus, SkyWalking
|
||||
* Supported protocols: HTTP, gRPC, tRPC
|
||||
* Multiple test report formats: Markdown, HTML, PDF, Stdout
|
||||
* Mock Server in simple configuration
|
||||
* Support converting to [JMeter](https://jmeter.apache.org/) files
|
||||
* Response Body fields equation check or [eval](https://expr.medv.io/)
|
||||
* Validate the response body with [JSON schema](https://json-schema.org/)
|
||||
* Pre and post handle with the API request
|
||||
* Run in server mode, and provide the [gRPC](pkg/server/server.proto) and HTTP endpoint
|
||||
* [VS Code extension](https://github.com/LinuxSuRen/vscode-api-testing) support
|
||||
* Multiple storage backends supported(Local, ORM Database, S3, Git, Etcd, etc.)
|
||||
* [HTTP API record](https://github.com/LinuxSuRen/atest-ext-collector)
|
||||
* Install in multiple use cases(CLI, Container, Native-Service, Operator, Helm, etc.)
|
||||
* Monitoring integration with Prometheus, SkyWalking
|
||||
|
||||
## Get started
|
||||
|
||||
|
|
@ -73,12 +73,14 @@ consume: 1m2.153686448s
|
|||
## Use in Docker
|
||||
|
||||
Use `atest` as server mode in Docker, then you could visit the UI from `8080`:
|
||||
```
|
||||
|
||||
```bash
|
||||
docker run --pull always -p 8080:8080 ghcr.io/linuxsuren/api-testing:master
|
||||
```
|
||||
|
||||
Use `atest-collector` in Docker:
|
||||
```shell
|
||||
|
||||
```bash
|
||||
docker run -p 1234:8080 -v /var/tmp:/var/tmp \
|
||||
ghcr.io/linuxsuren/api-testing atest-collector \
|
||||
--filter-path /api \
|
||||
|
|
@ -91,9 +93,9 @@ docker run -p 1234:8080 -v /var/tmp:/var/tmp \
|
|||
|
||||
The following fields are templated with [sprig](http://masterminds.github.io/sprig/):
|
||||
|
||||
* API
|
||||
* Request Body
|
||||
* Request Header
|
||||
* API
|
||||
* Request Body
|
||||
* Request Header
|
||||
|
||||
### Functions
|
||||
|
||||
|
|
@ -108,16 +110,28 @@ You could use all the common functions which comes from [sprig](http://mastermin
|
|||
|
||||
It could verify any kinds of Kubernetes resources. Please set the environment variables before using it:
|
||||
|
||||
* `KUBERNETES_SERVER`
|
||||
* `KUBERNETES_TOKEN`
|
||||
* `KUBERNETES_SERVER`
|
||||
* `KUBERNETES_TOKEN`
|
||||
|
||||
See also the [example](sample/kubernetes.yaml).
|
||||
|
||||
## TODO
|
||||
|
||||
* Reduce the size of context
|
||||
* Support customized context
|
||||
* Reduce the size of context.
|
||||
* Support customized context.
|
||||
|
||||
## Limit
|
||||
|
||||
* Only support to parse the response body when it's a map or array
|
||||
* Only support to parse the response body when it's a map or array.
|
||||
|
||||
## Community Exchange
|
||||
|
||||
Feel free to talk to us about any questions you may have about API Testing in the following ways.
|
||||
|
||||
### Mailing List
|
||||
|
||||
`api-testing-tech@googlegroups.com`, Feel free to discuss everything related to API Testing via this mailing list.
|
||||
|
||||
### Githbu discussion
|
||||
|
||||
[Github Discussion](https://github.com/LinuxSuRen/api-testing/discussions/new/choose)
|
||||
|
|
|
|||
Loading…
Reference in New Issue