openapi-tui 0.4.0

This TUI allows you to list and browse APIs described by the openapi specification.
openapi-tui-0.4.0 is not a library.

logo

openapi-tui

CI

Terminal UI to list, browse and run APIs defined with OpenAPI v3.0 spec.

Demo

demo

Nested Components

nested-refrences

Fullscreen

fullscreen

Installation

Install from source:

 cargo install openapi-tui

Or download pre-built artifact from release page.

Distro Packages

Packaging status

Arch Linux

You can install using pacman as follows:

 pacman -S openapi-tui

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
'f' Toggle fullscreen pane
g Go in nested items in lists
Backspace, b Get out of nested items in lists

Milestones

  • Viewer
  • OpenAPI v3.1
  • Remote API specification
  • Pane Fullscreen Mode
  • Nested Components
  • Status Line
  • Command Line
  • Execute