oq

oq - a terminal-based OpenAPI Spec (OAS) viewer

Usage

oq openapi.yaml
# or
cat openapi.yaml | oq
# or
curl https://api.example.com/openapi.json | oq

Keyboard Shortcuts

Press ? to see the help screen with all available keyboard shortcuts.

OpenAPI Support

oq supports all 3.* OpenAPI specification versions:

• 3.0
• 3.1
• 3.2

Both JSON and YAML formats are supported.

Note: oq uses the libopenapi library as it supports all OpenAPI versions and is actively maintained.

Installation

Using go install:

go install github.com/plutov/oq@latest

brew install plutov/tap/oq

yay -S oq-openapi-viewer-git

You can also download the compiled binaries from the Releases page.

From source

git clone git@github.com:plutov/oq.git
cd oq
go build -o oq .

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

When contributing:

1. Ensure tests pass: go test -v
2. Test all supported OpenAPI versions (3.0, 3.1, 3.2)
3. If the UI changes, make sure to run vhs preview.tape to generate a new preview GIF
4. Try to extend test coverage by introducing new example OpenAPI specs in the examples folder