/openapi-tui

Terminal UI to list, browse and run APIs defined with openapi spec.

Primary LanguageRustMIT LicenseMIT

logo

openapi-tui

CI

Terminal UI to list, browse and run APIs defined with openapi spec.

Demo

demo

Nested Comopnents

nested-refrences

Installation

Install from source:

❯ cargo install openapi-tui

Or download pre-built artifact from release page.

Usage

❯ openapi-tui --help
This TUI allows you to list and browse APIs described by the openapi specification.

Usage: openapi-tui [OPTIONS]

Options:
  -o, --openapi-path <PATH>  Input file, i.e. json or yaml file with openapi specification [default:
                             openapi.json]
  -h, --help                 Print help
  -V, --version              Print version

Keybindings

Key Action
→, l Move to next pane
←, h Move to previous pane
↓, j Move down in lists
↑, k Move up in lists
1...9 Move between tabs
g Go in nested items in lists
Backspace, b Get out of nested items in lists

Milestones

  • Viewer
  • Remote API specification
  • Pane Fullscreen Mode
  • Nested Components
  • Status Line
  • Command Line
  • Execute