openapi-tui

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

Demo

Nested Components

Fullscreen

Webhooks

Filter

Installation

Install from source:

❯ cargo install openapi-tui

Or download pre-built artifact from release page.

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
  ];
}

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

Features

• Viewer
• OpenAPI v3.1
• Display Webhooks
• Display Info and Version
• Search #12
• Display Key Mappings in Popup
• Execute
• Remote API specification
• Merge Parameters Based on in
• Pane Fullscreen Mode
• Nested Components
• Status Line
• Cache Schema Styles
• Read Spec from STDIN
• Command Line