{"id":13477712,"url":"https://github.com/zaghaghi/openapi-tui","last_synced_at":"2025-05-16T10:08:26.745Z","repository":{"id":225472169,"uuid":"766082951","full_name":"zaghaghi/openapi-tui","owner":"zaghaghi","description":"Terminal UI to list, browse and run APIs defined with openapi spec.","archived":false,"fork":false,"pushed_at":"2025-03-07T12:54:26.000Z","size":21290,"stargazers_count":804,"open_issues_count":4,"forks_count":17,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-08T01:07:26.862Z","etag":null,"topics":["openapi3","openapi31","ratatui-rs","rust-lang","tui"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zaghaghi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-02T09:42:10.000Z","updated_at":"2025-05-06T14:32:05.000Z","dependencies_parsed_at":"2024-04-14T22:34:24.385Z","dependency_job_id":null,"html_url":"https://github.com/zaghaghi/openapi-tui","commit_stats":null,"previous_names":["zaghaghi/openapi-tui"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaghaghi%2Fopenapi-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaghaghi%2Fopenapi-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaghaghi%2Fopenapi-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaghaghi%2Fopenapi-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zaghaghi","download_url":"https://codeload.github.com/zaghaghi/openapi-tui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254509477,"owners_count":22082892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi3","openapi31","ratatui-rs","rust-lang","tui"],"created_at":"2024-07-31T16:01:46.499Z","updated_at":"2025-05-16T10:08:21.736Z","avatar_url":"https://github.com/zaghaghi.png","language":"Rust","readme":"![logo](static/logo.png)\n# openapi-tui\n\n[![CI](https://github.com/zaghaghi/openapi-tui/workflows/CI/badge.svg)](https://github.com/zaghaghi/openapi-tui/actions)\n\nTerminal UI to list, browse and run APIs defined with OpenAPI v3.0 and v3.1 spec.\n\n\n# Usage\n```bash\n❯ openapi-tui --help\nThis TUI allows you to list and browse APIs described by the openapi specification.\n\nUsage: openapi-tui --input \u003cPATH\u003e\n\nOptions:\n  -i, --input \u003cPATH\u003e  Input file or url, in json or yaml format with openapi specification\n  -h, --help          Print help\n  -V, --version       Print version\n```\n\n## Examples\n```bash\n# open local yaml file\n❯ openapi-tui -i examples/stripe/spec.yml\n\n# open local json file\n❯ openapi-tui -i examples/petstore.json\n\n# open remote file\n❯ openapi-tui -i https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.yaml\n```\n\n\n# Demo\n![demo](static/demo.gif)\n\n# Other Feature Animations\n\u003cdetails\u003e\n  \u003csummary\u003eShow more\u003c/summary\u003e\n\n## Nested Components\n![nested-refrences](static/nested-refs.gif)\n\n## Fullscreen\n![fullscreen](static/fullscreen.gif)\n\n## Webhooks\n![webhooks](static/webhooks.gif)\n\n## Filter\n![filter](static/filter.gif)\n\n## Call Endpoints\n![call](static/call.gif)\n\n## Multiple Server Support\n![call](static/switch-server.gif)\n\n\u003c/details\u003e\n\n\u003cbr /\u003e\n\n\n# Installation\nInstall from source:\n```bash\n❯ cargo install openapi-tui\n```\nOr download pre-built artifact from release page.\n\n## Docker\nJust run the application with docker.\n\n```bash\n# open local file\n❯ docker run --rm -ti -v$(pwd)/examples:/opt zaghaghi/openapi-tui -i /opt/petstore.json\n\n# open remote file\n❯ 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\n```\n## Distro Packages\n\n\u003cdetails\u003e\n  \u003csummary\u003ePackaging status\u003c/summary\u003e\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/openapi-tui.svg)](https://repology.org/project/openapi-tui/versions)\n\n\u003c/details\u003e\n\n### Arch Linux\n\nYou can install using `pacman` as follows:\n\n```bash\n❯ pacman -S openapi-tui\n```\n\n### NixOS\n\nYou can install the `openapi-tui` package directly with the following command:\n\n```bash\nnix profile install github:zaghaghi/openapi-tui\n```\n\nYou can also install `openapi-tui` by adding it to your `configuration.nix` file.\n\n```nix\n# flake.nix\n\n{\n  inputs.openapi-tui.url = \"github:zaghaghi/openapi-tui\";\n  # ...\n\n  outputs = {nixpkgs, ...} @ inputs: {\n    nixosConfigurations.\u003cyour-hostname\u003e = nixpkgs.lib.nixosSystem {\n      specialArgs = { inherit inputs; }; # this is the important part\n      modules = [\n        ./configuration.nix\n      ];\n    };\n  }\n}\n```\n\nThen, add `openapi-tui` to your `configuration.nix`\n\n```nix\n# configuration.nix\n\n{inputs, pkgs, ...}: {\n  environment.systemPackages = with pkgs; [\n    inputs.openapi-tui.packages.${pkgs.system}.openapi-tui\n  ];\n}\n```\n\n\n# Keybindings\n\n| Key | Action|\n|:----|:-----|\n| `→`, `l`| Move to next pane |\n| `←`, `h` | Move to previous pane |\n| `↓`, `j` | Move down in lists |\n| `↑`, `k` | Move up in lists |\n| `1...9` | Move between tabs |\n| `]` | Move to next tab |\n| `[` | Move to previous tab |\n| `f` | Toggle fullscreen pane|\n| `g` | Go in nested items in lists|\n| `q` | Quit|\n| `/` | Filter apis|\n| `:` | Run commands|\n| `Backspace`, `b` | Get out of nested items in lists|\n\n# Commands Main Page\n| Command | Description |\n|:--------|:------------|\n| `q` | Quit |\n| `request`, `r` | Go to request page|\n| `history` | Request history|\n\n# Commands Request Page\n| Command | Description |\n|:--------|:------------|\n| `q` | Quit |\n| `send`, `s` | Send request |\n| `query`, `q` | Add or remove query strings. sub-commands are `add` or `rm`. e.g. `query add page` |\n| `header`, `h` | Add or remove headers. sub-commands are `add` or `rm`. e.g. `header add x-api-key` |\n| `request`, `r` | Load request payload. e.g. `request open /home/hamed/payload.json` |\n| `response`, `s` | Save response payload e.g/ `response save /home/hamed/result.json` |\n\n# Environment Variables\n| Variable | Description |\n|:---------|:------------|\n| `OPENAPI_TUI_DEFAULT_SERVER` | Add a custom server url to the list of servers|\n\n\n# Implemented Features\n- [X] Viewer\n- [X] OpenAPI v3.1\n- [X] Display Webhooks\n- [X] Display Info and Version\n- [X] Filter APIs\n- [X] Remote API specification\n- [X] Merge Parameters Based on `in`\n- [X] Pane Fullscreen Mode\n- [X] Nested Components\n- [X] Status Line\n- [X] Phone Page\n- [X] Call History\n- [X] Request Plain Editor\n- [X] Header Input (No Validation)\n- [X] Path Input (No Validation)\n- [X] Calling\n- [X] Plain Response Viewer (Status + Headers + Body)\n- [X] History viewer\n- [X] Refactor footer, add flash footer messages\n- [X] Import request body file\n- [X] Save response body and header\n- [X] Command history with ↑/↓\n- [X] Support array query strings\n- [X] Suppert extra headers\n- [X] Support multiple servers\n\n# Backlog\n- [ ] Schema Types (openapi-31)\n- [ ] Display Key Mappings in Popup\n- [ ] Read Spec from STDIN \n- [ ] Request progress bar","funding_links":[],"categories":["Rust","💻 Apps"],"sub_categories":["⌨️ Development Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaghaghi%2Fopenapi-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzaghaghi%2Fopenapi-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaghaghi%2Fopenapi-tui/lists"}