Skip to content

ikorason/lazy-swagger-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lazy Swagger Tui

A fast terminal UI for testing APIs directly from Swagger/OpenAPI specs.

Demo

Features

  • 🔍 Auto-discover endpoints from Swagger/OpenAPI
  • ⚡ Fast keyboard-driven workflow
  • 🔐 Bearer token authentication
  • 🔎 Live search and filtering
  • 📝 JSON body editor with auto-formatting
  • 🌐 All HTTP methods (GET, POST, PUT, PATCH, DELETE)
  • 🎨 Adapts to your terminal theme

Installation

From GitHub Releases

Download pre-built binaries for your platform from releases.

From source

git clone https://github.com/ikorason/lazy-swagger-tui
cd lazy-swagger-tui
cargo install --path .

This installs the binary to ~/.cargo/bin/lazy-swagger-tui. Make sure ~/.cargo/bin is in your $PATH.

Quick Start

lazy-swagger-tui

On first launch, configure:

  • Swagger URL: http://localhost:5000/swagger/v1/swagger.json
  • Base URL: http://localhost:5000

Then navigate with j/k and press Space to execute requests.

Keyboard Shortcuts

Key Action
j/k or / Navigate endpoints
Space Execute request
/ Search/filter
Tab / Shift+Tab Switch panels/tabs
e Edit parameter
b Edit JSON body (POST/PUT/PATCH)
a Set auth token
g Toggle grouped/flat view
1 / 2 Jump to panel
q Quit

Search

Press / and start typing to filter endpoints by path, method, summary, or tags. Press Esc to clear.

Configuration

Config is stored in ~/.config/lazy-swagger-tui/config.toml:

[server]
swagger_url = "http://localhost:5000/swagger/v1/swagger.json"
base_url = "http://localhost:5000"

Press , in the app to update URLs.

License

MIT

About

Test your ASP.NET APIs on the terminal

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages