Version, diff, and visualize your OpenAPI spec

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mariac27 from gravatar.com mariac27

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Tags openapi , fastapi , api , diff , changelog
  • Requires: Python >=3.10
  • Provides-Extra: serve , dev
Classifiers
Report project as malware

Project description

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

pip3 install "openapi-lens[serve]"

Usage

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.

License

MIT

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mariac27 from gravatar.com mariac27

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Tags openapi , fastapi , api , diff , changelog
  • Requires: Python >=3.10
  • Provides-Extra: serve , dev
Classifiers

Release history Release notifications | RSS feed

This version

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi_lens-1.0.5.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapi_lens-1.0.5-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file openapi_lens-1.0.5.tar.gz.

File metadata

  • Download URL: openapi_lens-1.0.5.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openapi_lens-1.0.5.tar.gz
Algorithm Hash digest
SHA256 0483580608290a77bd10c42ce84f8b0de1f5663162ce7c90bbb37b7e75ac22ac
MD5 558538f318618ce83f85d669312cb23d
BLAKE2b-256 c51432f22b9c4e305be0fd1cd7b5501b3f0f45c9e1b603ed29b2b5a0ee15103e

See more details on using hashes here.

Provenance

The following attestation bundles were made for openapi_lens-1.0.5.tar.gz:

Publisher: publish.yml on MariaC27/api-lens

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openapi_lens-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: openapi_lens-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openapi_lens-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 68c11ef8d67320c58a8b8021e9c157d5d3ff631f5630fa7fa4e87bbc080b03e0
MD5 5b75c8a39e8fe31a86af6a4484c23498
BLAKE2b-256 8dbca086cf8a320fef688446ffbac6c476f4ae7e104f316e25c0d99d1535169f

See more details on using hashes here.

Provenance

The following attestation bundles were made for openapi_lens-1.0.5-py3-none-any.whl:

Publisher: publish.yml on MariaC27/api-lens

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page