catalyst 0.2.9

A lightweight API testing tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Quickstart

This tutorial gets you from zero to a passing test in under five minutes.

## 1) Install Catalyst

```bash
cargo install catalyst --locked
```

Verify the install:

```bash
catalyst --help
```

## 2) Create the project structure

In your project folder, create the `.catalyst` directory and test file:

```bash
mkdir -p .catalyst
touch .catalyst/tests.toml
```

## 3) Add a minimal test

Paste the following into `.catalyst/tests.toml`:

```toml
[config]
base_url = "https://jsonplaceholder.typicode.com"

[[tests]]
name = "Fetch a post"
method = "GET"
endpoint = "/posts/1"
expected_status = 200
assertions = [
  { type = "contains", path = "userId", value = 1 },
  { type = "contains", path = "id", value = 1 }
]
```

Tip: Replace `base_url` with your API when ready.

## 4) Run the test

```bash
catalyst run
```

You should see a passing result. Use `-v` for verbose output.

## 5) Next steps

- Learn how to structure tests: [Your First Test](../getting-started/first_test)
- Explore CLI flags: [Run and Filter Tests](../getting-started/running_tests)
- See all options: [Schema Reference](../reference/schema)