Metadata-Version: 2.4
Name: openapi-lens
Version: 1.0.4
Summary: Version, diff, and visualize your OpenAPI spec
License: MIT
Project-URL: Homepage, https://github.com/MariaC27/api-lens
Project-URL: Issues, https://github.com/MariaC27/api-lens/issues
Keywords: openapi,fastapi,api,diff,changelog
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic>=2.0
Requires-Dist: click>=8.0
Requires-Dist: tomli>=2.0; python_version < "3.11"
Provides-Extra: serve
Requires-Dist: fastapi>=0.100; extra == "serve"
Requires-Dist: uvicorn[standard]>=0.20; extra == "serve"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: httpx>=0.24; extra == "dev"
Requires-Dist: fastapi>=0.100; extra == "dev"
Requires-Dist: uvicorn[standard]>=0.20; extra == "dev"
Dynamic: license-file

# ApiLens

Automatically generate versioned API snapshots on every merge. Explore changes between any two versions in a UI with color-coded diff highlighting. Built for FastAPI + TypeScript teams.

## Features

- **Automatic snapshots** — captures your spec on every merge to `main`; skips if nothing changed
- **Visual diff viewer** — color-coded UI showing new, removed, and modified endpoints with field-level detail
- **PR comments** — posts a Markdown summary of API changes on every pull request
- **AI prompts** — one-click copy of prompts to help update frontend TypeScript types
- **Zero integration** — no changes to your FastAPI app; runs completely standalone

## Install

```bash
pip3 install "openapi-lens[serve]"
```

## Usage

```bash
apilens serve
```

The viewer requires snapshots to be generated via GitHub Actions workflows. For full setup instructions, workflow templates, and configuration, see the [GitHub repository](https://github.com/MariaC27/api-lens).

## License

MIT
