Browse API documentation
Project description
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
api-browser-0.1.1.tar.gz
(6.7 kB
view details)
Built Distribution
File details
Details for the file api-browser-0.1.1.tar.gz.
File metadata
- Download URL: api-browser-0.1.1.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0c83a26ed090b31e6901c1bec7c0303c22cd5f13dd4a505c7b267645661b770b |
|
| MD5 | 12a4afeddbdbe08bf42397520d75e6fd |
|
| BLAKE2b-256 | d328a971233c31a70887ac57867ad6f95a9dc1d0f99a002615763a7b13e2f9b6 |
File details
Details for the file api_browser-0.1.1-py3-none-any.whl.
File metadata
- Download URL: api_browser-0.1.1-py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5079bc7412c0ac8c474ed6c3cb8737c7458ef506829e3377e425888f59c15826 |
|
| MD5 | c8fb79546c83cd4c18efb3aae5693a7b |
|
| BLAKE2b-256 | 6bf668f3d42e42ab008334e725f7461f97420c750defe169857045b3f5f6c8af |
