1. Project Overview

API Testing

An open-source API testing tool.

A command-line-based API testing tool that supports HTTP response validation and generates test reports in formats such as Markdown. An alternative to Postman!!!

2. Open Source License

Licensed under Apache-2.0

3. Screenshots

4. Feature Overview

Functional characteristics

• Supported Protocols: HTTP, gRPC, tRPC
• Supports exporting test results in multiple formats: Markdown, HTML, PDF, Stdout
• Simple and easy-to-use Mock service with OpenAPI support
• Supports conversion to JMeter file format
• Supports response body field validation or eval
• Uses [JSON schema] to validate response parameters
• Supports preprocessing and postprocessing of API requests
• Supports running in server mode with gRPC and HTTP endpoints
• VS Code extension support
• GitHub extension support
• Supports multiple storage methods (Local, ORM Database, S3, Git, Etcd, etc.)
• HTTP API record
• Supports multiple installation methods (CLI, Container, Native-Service, Operator, Helm, etc.)
• Integrates Prometheus and SkyWalking monitoring

5. Tech Stack

Quick Start

Install via hd or download from releases:

hd install atest

You can also install via Kubernetes. For more details, please refer to: manifests.

Usage is as follows:

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 usage example: In this example, you will view the generated API test report in MD format:

atest run -p sample/testsuite-gitlab.yaml --duration 1m --thread 3 --report md

Using Docker

See the README.md documentation for details