DocTreen

Roadmap

Go deep, not wide. Logging, security, auth, and APM stay out of scope.

Strategy: go deep, not wide. Logging, security, auth, and APM stay out of scope — doctreen's moat is making the route registry the single source of truth. Everything below extends that registry into adjacent capabilities.

Shipped

  • ✅ Runtime validation middleware v1.6 — Zod schemas validate incoming requests; 422 on mismatch.
  • ✅ OpenAPI 3.1 export v1.7 — same schema bag drives Scalar, Redoc, and Swagger UI via GET /docs/openapi.json.
  • ✅ Security + hidden routes v1.8 — declare auth schemes once, attach to operations automatically; Authorization header auto-stripped; routes can opt out of docs entirely.
  • ✅ headHtml config v1.9 — inject analytics scripts, custom CSS, favicons, or OG metadata into the docs UI <head> without forking.
  • ✅ Schema drift detection — production grade v1.10 — structured pipeline with per-route aggregates and hourly buckets, opt-in sampling (default 1 %), onDrift callback + webhook dispatch, pluggable DriftStore interface, Drift tab in the UI, and npx doctreen drift report --fail-on-mismatch for CI.
  • ✅ Drift reset endpoint, daily buckets, Redis store reference v1.10.1 — opt-in POST <docsPath>/drift/reset gated by drift.allowReset + optional resetToken, companion npx doctreen drift reset CLI, rolling 7-day dailyBuckets, and a complete Redis-backed DriftStore reference.
  • ✅ OpenAPI polish v1.11 — $ref-based components.schemas dedup, first-class per-route + top-level tags, OpenAPI 3.1 callbacks and webhooks, multi-example bodies and responses, npx doctreen lint openapi.
  • ✅ Mock server v1.12 — npx doctreen mock --from <url|file> spins up an Express-backed fake API in seconds. CRUD short-circuits, --latency, --error-rate, --persist, optional @faker-js/faker.
  • ✅ Typed codegen v1.13 — npx doctreen codegen types emits strict TS declarations from components.schemas plus per-operation Params/Query/Body/Response shapes; npx doctreen codegen client emits a zero-dependency typed fetch client with createClient({ baseUrl, fetch?, headers?, onRequest? }). --watch for dev. Works with any OpenAPI 3.x doc.
  • ✅ Schema builders v1.14 — s.enum / s.nullable / s.default / s.literal value-level facets, emitted everywhere (OpenAPI, docs UI, request examples).
  • ✅ Validation completeness v1.15 — path-param schemas (request.params) with a structured 422, coerce/default write-back onto the request, dev-mode response assertions (validate: { response: 'warn' | 'throw' }), status-keyed responses (response: { 201: … }), config-level defaultErrors, a named DoctreenValidationError 422 envelope, defineSchema that works with Zod ($ref, no anonymous SchemaN), and offline getOpenApiDocument / doctreen emit-openapi.

Next up

  • ⏳ AI-native endpoints v1.16 — /docs/llm.txt, /docs/agents.json, and npx doctreen mcp (Model Context Protocol server) so Claude and other agents discover your API as callable tools.
  • ⏳ Contract testing & spec diff v1.17 — npx doctreen verify --against <url> checks a deployed API against the spec; npx doctreen diff old.json new.json surfaces breaking changes with semver hints. GitHub Action included.
  • ⏳ doctreen init CLI v1.18 — detect the framework, inject adapter mount code, scaffold validation/OpenAPI config.

Long term

  • 🔭 Python (FastAPI) and Go (chi / gin) adapters — Pydantic → SchemaNode for the Python side; once the Node story is fully baked.
  • 🔭 DocTreen Cloud — hosted docs portal with versioning, custom domains, drift monitoring, and CI flow runs (private beta).

Have a feature request or use case we missed? Open an issue →

Changelog

Notable releases and what they shipped.

On this page

ShippedNext upLong term