Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zaghaghi/openapi-tui

Terminal UI to list, browse and run APIs defined with openapi spec.
https://github.com/zaghaghi/openapi-tui

openapi3 openapi31 ratatui-rs rust-lang tui

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README 

        
![logo](static/logo.png)

# openapi-tui



[![CI](https://github.com/zaghaghi/openapi-tui/workflows/CI/badge.svg)](https://github.com/zaghaghi/openapi-tui/actions)



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



# Usage

```bash

❯ openapi-tui --help

This TUI allows you to list and browse APIs described by the openapi specification.



Usage: openapi-tui --input 



Options:

  -i, --input   Input file or url, in json or yaml format with openapi specification

  -h, --help          Print help

  -V, --version       Print version

```



## Examples

```bash

# 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

![demo](static/demo.gif)



# Other Feature Animations



  Show more



## Nested Components

![nested-refrences](static/nested-refs.gif)



## Fullscreen

![fullscreen](static/fullscreen.gif)



## Webhooks

![webhooks](static/webhooks.gif)



## Filter

![filter](static/filter.gif)



## Call Endpoints

![call](static/call.gif)



## Multiple Server Support

![call](static/switch-server.gif)







# Installation

Install from source:

```bash

❯ cargo install openapi-tui

```

Or download pre-built artifact from release page.



## Docker

Just run the application with docker.



```bash

# 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



  Packaging status



[![Packaging status](https://repology.org/badge/vertical-allrepos/openapi-tui.svg)](https://repology.org/project/openapi-tui/versions)



### Arch Linux



You can install using `pacman` as follows:



```bash

❯ pacman -S openapi-tui

```



### NixOS



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



```bash

nix profile install github:zaghaghi/openapi-tui

```



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



```nix

# flake.nix



{

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

  # ...



  outputs = {nixpkgs, ...} @ inputs: {

    nixosConfigurations. = nixpkgs.lib.nixosSystem {

      specialArgs = { inherit inputs; }; # this is the important part

      modules = [

        ./configuration.nix

      ];

    };

  }

}

```



Then, add `openapi-tui` to your `configuration.nix`



```nix

# configuration.nix



{inputs, pkgs, ...}: {

  environment.systemPackages = with pkgs; [

    inputs.openapi-tui.packages.${pkgs.system}.openapi-tui

  ];

}

```



# 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 |

| `]` | Move to next tab |

| `[` | Move to previous tab |

| `f` | Toggle fullscreen pane|

| `g` | Go in nested items in lists|

| `q` | Quit|

| `/` | Filter apis|

| `:` | Run commands|

| `Backspace`, `b` | Get out of nested items in lists|



# Commands Main Page

| Command | Description |

|:--------|:------------|

| `q` | Quit |

| `request`, `r` | Go to request page|

| `history` | Request history|



# Commands Request Page

| Command | Description |

|:--------|:------------|

| `q` | Quit |

| `send`, `s` | Send request |

| `query`, `q` | Add or remove query strings. sub-commands are `add` or `rm`. e.g. `query add page` |

| `header`, `h` | Add or remove headers. sub-commands are `add` or `rm`. e.g. `header add x-api-key` |

| `request`, `r` | Load request payload. e.g. `request open /home/hamed/payload.json` |

| `response`, `s` | Save response payload e.g/ `response save /home/hamed/result.json` |



# Environment Variables

| Variable | Description |

|:---------|:------------|

| `OPENAPI_TUI_DEFAULT_SERVER` | Add a custom server url to the list of servers|



# 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

- [X] Support multiple servers



# Backlog

- [ ] Schema Types (openapi-31)

- [ ] Display Key Mappings in Popup

- [ ] Read Spec from STDIN 

- [ ] Request progress bar