mgf-apiprobe 0.2.0

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

mgf-apiprobe

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

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 in v0.1; OAuth2 later.
• Matchers — DSL for asserting response shape (format + semantic; IBAN, IMEI, E.164 included).

Status: pre-publish — v0.1.0 is the first scope-reduced release per HANDOFF.md §6 + DEFERRED.md. Everything past the core engine + ~18 checks + 3 CLI subcommands is deferred and tracked in DEFERRED.md.

Install

pip install mgf-apiprobe

Optional extras (forward-declared; see DEFERRED.md for ship-when):

pip install 'mgf-apiprobe[openapi]'   # OpenAPI ingestion (v0.2)
pip install 'mgf-apiprobe[faker]'     # Faker-backed factories (v0.2)
pip install 'mgf-apiprobe[signing]'   # Cassette signing (v0.3)

Quick start (v0.1)

Once v0.1.0 publishes; placeholder until the implementation lands.

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 graduates to L2 by its own v1.0. See LIFT_CHECKLIST.md.

Layout

File	Purpose
DESIGN.md	The v0.3 design spec (≈ 1990 lines) with v0.4 sibling-decision addendum. WHAT we're building.
HANDOFF.md	Integration plan. HOW it ships as a sibling of mgf-common.
DEFERRED.md	Scope-reduction tracker. WHICH parts of WHAT ship in v0.1 vs. later.
LIFT_CHECKLIST.md	Federation conformance acknowledgment.
CHANGELOG.md	Per-release notes.

License

MIT. See LICENSE (TBD).