openapi-tui

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

Usage

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

Usage: openapi-tui --input <PATH>

Options:
  -i, --input <PATH>  Input file or url, in json or yaml format with openapi specification
  -h, --help          Print help
  -V, --version       Print version

Examples

# open local yaml file
❯ openapi-tui -i examples/stripe/spec.yml

# open local json file
❯ openapi-tui -i examples/petstore.json

# open remote file
❯ openapi-tui -i https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.yaml

Demo

Other Feature Animations

Installation

Install from source:

❯ cargo install openapi-tui

Or download pre-built artifact from release page.

Docker

Just run the application with docker.

# open local file
❯ docker run --rm -ti -v$(pwd)/examples:/opt zaghaghi/openapi-tui -i /opt/petstore.json

# open remote file
❯ docker run --rm -it zaghaghi/openapi-tui -i https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.yaml

Distro Packages

Arch Linux

You can install using pacman as follows:

❯ pacman -S openapi-tui

NixOS

You can install the openapi-tui package directly with the following command:

nix profile install github:zaghaghi/openapi-tui

You can also install openapi-tui by adding it to your configuration.nix file.

# flake.nix

{
  inputs.openapi-tui.url = "github:zaghaghi/openapi-tui";
  # ...

  outputs = {nixpkgs, ...} @ inputs: {
    nixosConfigurations.<your-hostname> = nixpkgs.lib.nixosSystem {
      specialArgs = { inherit inputs; }; # this is the important part
      modules = [
        ./configuration.nix
      ];
    };
  }
}

Then, add openapi-tui to your configuration.nix

# configuration.nix

{inputs, pkgs, ...}: {
  environment.systemPackages = with pkgs; [
    inputs.openapi-tui.packages.${pkgs.system}.openapi-tui
  ];
}

Keybindings

Commands Main Page

Commands Request Page

Implemented Features

• [X] Viewer
• [X] OpenAPI v3.1
• [X] Display Webhooks
• [X] Display Info and Version
• [X] Filter APIs
• [X] Remote API specification
• [X] Merge Parameters Based on in
• [X] Pane Fullscreen Mode
• [X] Nested Components
• [X] Status Line
• [X] Phone Page
• [X] Call History
• [X] Request Plain Editor
• [X] Header Input (No Validation)
• [X] Path Input (No Validation)
• [X] Calling
• [X] Plain Response Viewer (Status + Headers + Body)
• [X] History viewer
• [X] Refactor footer, add flash footer messages
• [X] Import request body file
• [X] Save response body and header
• [X] Command history with ↑/↓
• [X] Support array query strings
• [X] Suppert extra headers

Backlog

• [ ] Schema Types (openapi-31)
• [ ] Display Key Mappings in Popup
• [ ] Read Spec from STDIN
• [ ] Request progress bar