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

1.0.5

This version

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.4.tar.gz (18.0 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.4-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_lens-1.0.4.tar.gz
  • Upload date:
  • Size: 18.0 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.4.tar.gz
Algorithm Hash digest
SHA256 d718d3befdb81fc431586a476613d98a78cc876a70c3daca54b1fd5ba34a5d1e
MD5 1f10f2c952635e044dd7b2a5fea855eb
BLAKE2b-256 185549e6b7f672338a1d40a27fc495c81ab05a5a6ee513fcf359dd330dbcae75

See more details on using hashes here.

Provenance

The following attestation bundles were made for openapi_lens-1.0.4.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.4-py3-none-any.whl.

File metadata

  • Download URL: openapi_lens-1.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ef3bb1e993332ce4834258ab34c5c30d696d7826e1913365cc7e975071ec61e1
MD5 7302f0d224baf7dc95c4e678ac56196f
BLAKE2b-256 24d94a840a2822bcbf5a7bdb1d2da55a8c9c6abb1197bcda40157b9d6d7a0c0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for openapi_lens-1.0.4-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