Skip to main content

Jentic Apitools Analyze

Project description

analyze

Multi-backend OpenAPI validation using Redocly, Spectral, Speclynx, and optional LLM-powered semantic analysis. Produces unified diagnostics with severity, source, and structured metadata.

Key Features

The OpenAPIAnalyzer class validates specs against multiple backends in parallel. Redocly checks standards compliance, Spectral applies linting rules, the Speclynx backend uses the ApiDOM engine with custom JavaScript plugins for reference resolution analysis, and the optional semantic backend uses LLMs to evaluate description clarity. Each backend produces JenticDiagnostic objects with consistent severity levels. Error handling wraps each backend so failures don't block others.

Dependencies

Internal: jentic.apitools.common, jentic.apitools.llm. External: jentic-openapi-validator (with redocly, spectral, and speclynx backends), DeepDiff.

Installation

uv add analyze

Quick Start

from jentic.apitools.analyze.openapi_analyzer import OpenAPIAnalyzer
from jentic.apitools.common.models import DiagnosticTarget

analyzer = OpenAPIAnalyzer()
diagnostics = analyzer.analyze(
    "file:///path/to/spec.json",
    base_url="https://api.example.com",
    target=DiagnosticTarget.BUNDLED_SPEC,
)
print(f"Found {len(diagnostics)} issues")

Testing

uv run --package analyze pytest packages/analyze/tests -v

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

jentic_apitools_analyze-0.0.0a3-py3-none-any.whl (48.9 kB view details)

Uploaded Python 3

File details

Details for the file jentic_apitools_analyze-0.0.0a3-py3-none-any.whl.

File metadata

File hashes

Hashes for jentic_apitools_analyze-0.0.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 47ce56a083d8d73a88cd50e76f4f43a9b948c31936ef64417029d51dea1c6dd6
MD5 ef79f35fb0cc2c9481a0338946eabf01
BLAKE2b-256 5bb9d17efe51fd33f7f6a89ad6cf04c6d63cd0792153ca1cbf19821b5d924139

See more details on using hashes here.

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