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.
api_browser summary <filename>
Display a summary table of the API endpoints in the terminal.
api_browser schema <filename> <schema_name>
Display a schema from the OpenAPI file in a concise tree format. Required properties are marked with an asterisk (*).
api_browser urls <filename>
Display a tree view of URL segments from the OpenAPI file, showing how endpoints are hierarchically organized. Each endpoint shows its available operation IDs.
Example:
├── customers (listCustomers, createCustomer)
│ ├── {id} (getCustomer, updateCustomer, deleteCustomer)
│ │ └── orders (listCustomerOrders, createCustomerOrder)
│ │ └── {orderId} (getCustomerOrder, updateCustomerOrder, deleteCustomerOrder)
│ └── search (searchCustomers)
└── orders (listOrders, createOrder)
└── {id} (getOrder, updateOrder, deleteOrder)
This visualization helps understand the API's URL structure, how different endpoints are related, and what operations are available at each endpoint.
api_browser validate <filename>
Validate an OpenAPI file against the OpenAPI 3.0 specification. Shows a checkmark (✓) if valid or an error message (✗) with details if there are validation issues.
Example of valid file:
✓ OpenAPI specification is valid
Example of invalid file:
✗ Error: 'openapi' is a required property
Development
Installation
Clone the repository and install the package in development mode with test dependencies:
pip install -e ".[test]"
Running Tests
Run all tests:
pytest
Update snapshots when output changes:
pytest --snapshot-update
Update specific test snapshots:
pytest -k "test_name" --snapshot-update
Commands
api-browser openapi <filename>
Start a local server to view the OpenAPI documentation in a web browser.
api-browser summary <filename>
Display a summary table of all API endpoints, including:
- Path
- HTTP Method
- Operation ID
- Status Code
- Request Schema
- Response Schema
api-browser schema <filename> <schema_name>
Display a schema from the OpenAPI file in a tree format. Required properties are marked with an asterisk (*).
Example:
Schema: User
* indicates required property
├── id* (integer)
├── name* (string)
├── email (string)
└── address (Address)
├── street* (string)
├── city (string)
└── country (string)
Metadata
Release files for api-browser 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| api_browser-0.2.0.tar.gz | 13.8 kB | With provenance | Details for api_browser-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| api_browser-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for api_browser-0.2.0-py3-none-any.whl |
Total release size: 26.0 kB
Release files / api_browser-0.2.0.tar.gz
| Download URL | api_browser-0.2.0.tar.gz |
|---|---|
| Size | 13.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9935c981fd8bf24ff75e5d850951a4c0322de89fc7d26fd59013283667cf6c02
|
|
BLAKE2b-256 checksum How to use checksums |
1bcedd71f44e9e7611952835b2ff560b64dc7a327eb4a493324f5e222f80a29d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 30, 2024.
Transparency logRelease files / api_browser-0.2.0-py3-none-any.whl
| Download URL | api_browser-0.2.0-py3-none-any.whl |
|---|---|
| Size | 12.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b650f1925ff6ff8a194f46a02ef4fd380f31082aacee1088bfa4f09972f3a4e
|
|
BLAKE2b-256 checksum How to use checksums |
1dd9acefb27e036318e112c5b0900e30b26dcf5f3eca3e3206563e83717a3118
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 30, 2024.
Transparency logSecurity for api-browser 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for api_browser-0.2.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 30, 2024.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.