nils-api-grpc 0.6.5

CLI crate for nils-api-grpc in the nils-cli workspace.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# api-grpc

## Overview

api-grpc executes JSON-defined GRPC request files, prints response bodies to stdout, keeps
optional history, and can generate Markdown reports.

## Usage

```text
Usage:
  api-grpc <command> [args]

Commands:
  call             Execute a request file and print the response body to stdout (default)
  history          Print the last (or last N) history entries
  report           Generate a Markdown API test report
  report-from-cmd  Generate a report from a saved `call` snippet

Help:
  api-grpc --help
  api-grpc call --help
  api-grpc history --help
  api-grpc report --help
  api-grpc report-from-cmd --help
```

## Commands

- `call` (default): Execute a request file and print the response body.
  Options: `--env <name>`, `--url <url>`, `--token <name>`, `--config-dir <dir>`, `--no-history`.
- `history`: Print the last entry or tail N entries.
  Options: `--config-dir <dir>`, `--file <path>`, `--last`, `--tail <n>`, `--command-only`.
- `report`: Generate a Markdown report for a request.
  Options: `--case <name>`, `--request <file>`, `--run` | `--response <file|->`, `--out <path>`,
  `--env <name>`, `--url <url>`, `--token <name>`, `--no-redact`, `--no-command`,
  `--no-command-url`, `--project-root <path>`, `--config-dir <dir>`.
- `report-from-cmd`: Generate a report from a saved `call` command snippet.
  Options: `--case <name>`, `--out <path>`, `--response <file|->`, `--allow-empty`, `--dry-run`,
  `--stdin`.

## Quickstart

### 1) Setup files

```text
setup/grpc/
  endpoints.env
  tokens.env
  requests/
    health.grpc.json
```

`setup/grpc/endpoints.env`

```bash
GRPC_URL_LOCAL=127.0.0.1:50051
```

`setup/grpc/tokens.env`

```bash
GRPC_TOKEN_DEFAULT=<jwt-or-access-token>
```

`setup/grpc/requests/health.grpc.json`

```json
{
  "method": "health.HealthService/Check",
  "body": {
    "service": "payments"
  },
  "plaintext": true,
  "expect": {
    "status": 0,
    "jq": ".ok == true"
  }
}
```

### 2) Call + history

```bash
api-grpc call --env local --token default setup/grpc/requests/health.grpc.json
api-grpc history --tail 5
```

### 3) Report

```bash
api-grpc report --case grpc-health --request setup/grpc/requests/health.grpc.json --run
api-grpc history --command-only | api-grpc report-from-cmd --stdin --dry-run
```

## Runtime dependency

- Unary execution uses `grpcurl` backend (`GRPCURL_BIN` can override executable path).
- Install:
  - macOS: `brew install grpcurl`

## Docs

- [Docs index](docs/README.md)