OpenAPI Kit

Python tools to work with OpenAPI schemas

---

Documentation: https://frankie567.github.io/openapi-kit/

Source Code: https://github.com/frankie567/openapi-kit

---

OpenAPI TUI

Explore any OpenAPI schema right in your terminal — no browser required.

uvx openapi-kit view https://petstore3.swagger.io/api/v3/openapi.json

You can also point it at a local file:

uvx openapi-kit view ./my-api.yaml

Features

• Endpoints browser — all routes grouped by tag in a navigable tree, with per-endpoint details across dedicated tabs: Info, Path parameters, Query parameters, Headers, Request body, and Responses.
• Schemas browser — browse every component schema with a full property table including types, constraints, and required markers.
• Schema navigation — clickable schema links inside endpoint and schema detail panels let you jump straight to the referenced type, with breadcrumb-style back navigation.
• Live reload — press Ctrl+R to re-fetch the schema from its original source without leaving the TUI.
• Keyboard-driven — switch between Endpoints (E) and Schemas (S) views, quit with Q or Ctrl+C.

Screenshots

Endpoints list

Endpoint detail

Schemas list

Schema detail

OpenAPI Diff

Compare two OpenAPI schemas and output the differences.

uvx openapi-kit diff ./v1.yaml ./v2.yaml

The diff command supports both JSON and Markdown output formats:

# Markdown output (default)
uvx openapi-kit diff ./v1.yaml ./v2.yaml

# JSON output
uvx openapi-kit diff ./v1.yaml ./v2.yaml --format json

Features

• Endpoint comparison: Detects added, removed, and modified endpoints
• Schema changes: Identifies schema additions, removals, and modifications
• Detailed output: Shows exactly what changed in each endpoint or schema
• Multiple formats: Choose between human-readable Markdown or machine-readable JSON output
• URL and file support: Compare schemas from local files or remote URLs

Example Output

The diff command outputs a structured comparison showing:

# OpenAPI Schema Diff

## Endpoints

### Added

- POST /new-endpoint

### Removed

- GET /old-endpoint

### Modified

- GET /updated-endpoint
    - Description changed
    - Added new query parameter

## Schemas

### Added

- NewSchema

### Removed

- OldSchema

### Modified

- UpdatedSchema
    - Added new property
    - Changed type constraint

This makes it easy to review API changes between versions and generate changelogs.

---

Development

Setup environment

We use uv to manage the development environment and production build, and just to manage command shortcuts. Ensure they are installed on your system.

Run unit tests

You can run all the tests with:

just test

Format the code

Execute the following command to apply linting and check typing:

just lint

Regenerate screenshots

The screenshots in this README are generated from a live Petstore schema using Textual's headless mode:

uv run scripts/generate_screenshots.py

Publish a new version

You can bump the version, create a commit and associated tag with one command:

just version patch

just version minor

just version major

Your default Git text editor will open so you can add information about the release.

When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.

Serve the documentation

You can serve the Mkdocs documentation with:

just docs-serve

It'll automatically watch for changes in your code.

License

This project is licensed under the terms of the MIT license.