smizell / api-browser

View documentation for your API from your command line

api-browser

Browse API documentation

Installation

You can use pipx to install this tool.

• Install pipx
• Run pipx install api-browser

You can also use pip:

pip install api-browser

Usage

See api_browser --help for all details.

api_browser openapi <filename>

Load the OpenAPI file and show Redoc documentation. Refresh the page to load any changes to the OpenAPI file.

Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

cd api-browser
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest