mgf-apiprobe 0.5.2

REST API verification — typed probes, checks, and findings. Sibling of mgf-common.

mgf-apiprobe

REST API verification — typed probes, checks, and findings.

Shape: Federation sibling of mgf-common. The current mgf-common pin window is shown in this package's PyPI metadata — sourced from pyproject.toml at release time, so this README can't go stale. (Per v2.6 DOC-01 / project-shape taxonomy. PAPER-38.)

mgf-apiprobe is the API-verification sibling of mgf-common. It builds on mgf-common's settings, error, and observability primitives, and adds:

• Probes — typed descriptions of an HTTP request + the expected response shape.
• Checks — pluggable verifiers that emit structured Findings (code, severity, root_cause, evidence, remediation).
• Suites — collections of probes that run async and produce a Report.
• AuthFlows — bearer / basic / api-key / cookie / custom; OAuth2 is a future add.
• Matchers — DSL for asserting response shape (format + semantic; IBAN, IMEI, E.164 included).

Install

pip install mgf-apiprobe

Optional extras (forward-declared):

pip install 'mgf-apiprobe[openapi]'   # OpenAPI ingestion
pip install 'mgf-apiprobe[faker]'     # Faker-backed factories
pip install 'mgf-apiprobe[signing]'   # Cassette signing

Quick start

from mgf.apiprobe import Probe, Suite, BearerAuth

probe = (
    Probe.get("https://httpbin.org/get")
    .with_auth(BearerAuth(token="..."))
    .expects_status(200)
    .expects_json_shape({"url": str, "headers": dict})
)

suite = Suite([probe])
report = await suite.run()
print(report.to_human())

Standards

This package targets mgf-common's L1 — Production-Ready standards day-one (BaseAppSettings, AppError, structured logging, redaction, py.typed, semver, ≥80% coverage, no secrets in cassettes/logs). It will graduate to L2 as the sibling matures. See LIFT_CHECKLIST.md.

Layout

File	Purpose
DESIGN.md	The design spec (≈ 1990 lines). WHAT we're building.
HANDOFF.md	Integration plan. HOW it ships as a sibling of mgf-common.
LIFT_CHECKLIST.md	Federation conformance acknowledgment.

License

MIT. See LICENSE (TBD).