apin 0.2.2

Terminal UI for navigating OpenAPI specs
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

# apin - OpenAPI Navigator CLI

[![CI](https://github.com/ekvii/apin/actions/workflows/ci.yml/badge.svg)](https://github.com/ekvii/apin/actions/workflows/ci.yml)
[![Release](https://github.com/ekvii/apin/actions/workflows/release.yml/badge.svg)](https://github.com/ekvii/apin/actions/workflows/release.yml)

A terminal UI for navigating OpenAPI specs — fast, keyboard-driven, zero configuration.

Browse any number of specs with a Miller-columns path tree, inspect endpoints in a
full-screen detail view, and filter with incremental search — all without leaving
the terminal.

Supports OpenAPI **3.0** and **3.1**, YAML or JSON.

![apin demo](assets/apin.gif)

## Installation

### Homebrew (macOS and Linux)

```sh
brew install ekvii/apin/apin
```

### cargo install

```sh
cargo install apin
```

### Binaries (Linux, macOS, Windows)

[Latest release binaries](https://github.com/ekvii/apin/releases/latest) are available for Linux, macOS, and Windows. Download the binary for your platform and add it to your `PATH`.

### Build from source

Requires [Rust](https://rustup.rs) (stable).

```sh
cd apin
cargo build --release
./target/release/apin path/to/spec.yaml
```

## Usage

```sh
# single spec file
apin openapi.yaml

# entire directory — specs stream into the UI as they load
apin path/to/specs/

# HTTP(S) URL — probes well-known spec paths automatically
apin https://api.example.com

# explicit spec URL
apin https://api.example.com/openapi.yaml

# dir for downloaded specs (re-uses existing files on next run)
apin --download-dir . https://api.example.com

# force re-download even if the file already exists
apin --download-dir . --force-download https://api.example.com
```

## Features

- **Miller-columns tree** — navigate URL path segments column by column (`h` / `l`)
- **Endpoint detail** — method, summary, parameters, request body, response codes
- **Schema tree** — collapsible, interactive view of request body schemas
- **Incremental search** — `/` to filter in any panel; `n` / `N` to cycle matches
- **Vim-style navigation** — `j`/`k`, `gg`/`G`, `Ctrl-D`/`Ctrl-U`
- **Multi-spec** — load a whole directory; switch between specs in a sidebar
- **URL input** — pass any HTTP(S) URL; apin probes well-known spec paths automatically
- **Download remote spec files** — `--download-dir` persists downloaded specs and skips re-downloading; use `--force-download` to override