#API Workbench Pro — Documentation Index

• Title: Documentation Index (landing page)
• Generated at: 2026-06-13
• Repository: api-workbench-pro
• Branch: main
• Revision: v0.9.0
• Audience: Everyone — new users, API designers, integration engineers, ops/SRE, tech leads, auditors, and procurement/security reviewers
• Confidence: high
• Related documents: BUSINESSSSYSTEMREFERENCE.md · USER_MANUAL.md · PROCESS_FLOWS.md · NAVIGATION_TREE.md · TECHNICAL_ARCHITECTURE.md · FEATURE_CATALOG.md · READINESS_PLATFORM.md · ROLEEPERMISSIONMATRIX.md · DATAAFLOWANDDENTITYREFERENCE.md · CHANGEEINTELLIGENCEAPPENDIX.md · DOCCGENERATIONREPORT.md · HELPPMENUMASTERFILE.json · ARCHITECTURE.md · GDPR.md · README.md

#What is API Workbench Pro?

API Workbench Pro is an offline-first API integration workbench that covers the entire API
lifecycle — import → design → mock → map → run → govern → ship-readiness — inside a single
browser app. There is no backend, no account system and no sync service: every byte of your
workspace data lives in your own browser's localStorage. The vendor never receives it and has no
technical means to.

That single architectural choice is the product's flagship promise: **zero-egress, GDPR by
architecture**. Your specs, endpoints, mappings, runs, traces and audit log generate zero outbound
network traffic; the only times the app touches the network are three explicit, user-initiated flows
(a live request you Send, a spec you import from a URL, and a webhook you configured for a
scheduled run).

• Live app: <https://api-workbench-pro.lovable.app/>
• In-app help center: the Documentation Center at /docs renders this same documentation
• Internal codename in the code: ApiBox (you will see apibox.* storage keys).

New here? Jump to Start here — by persona for the fastest path to
being productive in your role.

#The documentation set

Thirteen Markdown documents make up the help center. Every one is grounded in the real routes,
entities and code of API Workbench Pro (v0.9.0, with the v0.9.1 Readiness Platform Guide added on
top); verified facts are kept separate from inferred ones, and each document cross-links the others. The in-app Documentation Center (/docs) discovers and
renders these files; the Help Menu masterfile is the machine-readable
manifest that drives the in-app menu.

Newest addition (v0.9.1): the Readiness Platform Guide documents the
now ten-dimension Readiness Scorecard and the four dedicated readiness pages (API Inventory,
Resilience Lab, Agent Readiness, Compatibility Matrix) added since the v0.9.0 wave.

The Readiness Scorecard (/readiness) — now ten dimensions — and its dedicated check
surfaces (Governance & Lint, Security Posture, Trace Readiness, Drift Radar, Validation Engine,
API Inventory, Resilience Lab, Agent Readiness, Compatibility Matrix) are covered end-to-end in the
Readiness Platform Guide and enumerated in the
Feature Catalog; their end-to-end flows are in
Process Flows and their data/engine contract in
Technical Architecture.

Pre-existing provenance docs (preserved, cross-linked — not part of the numbered help set):
ARCHITECTURE.md, GDPR.md,
trust/security-overview.md,
trust/DPA-template.md. These are the source-of-truth provenance pages a
security or procurement reviewer reads; the help-center docs cross-link them and never duplicate
them.

#Start here — by persona

API Workbench Pro is role-aware. You set your active role by impersonation in Settings
(/settings); each persona has a default role (see Role Permission Matrix).
Below is the fastest productive path for each.

#API Designer (default role: editor)

You import specs and shape endpoints, schemas and scenarios.

1. User Manual → the shell + the API Catalog & Import (/catalog, /import)
2. Process Flows → Import OpenAPI and *Endpoint design → scenarios →
3. Feature Catalog → Data Packs (/data-packs), Scenarios
4. Feature Catalog → run a Governance & Lint (/governance) pass on your

#Integration Engineer (default role: editor)

You wire APIs together with field mappings and run scenario suites.

1. User Manual → API Explorer (/api-explorer) and Mapping Studio
2. Process Flows → Mapping build → review → production lock and *Schema
3. Feature Catalog → Mapping Reviews (/mapping-reviews), Prevalidation
4. Change Intelligence Appendix → understand which modules a spec

#Ops / SRE (default role: operator)

You run, schedule, smoke-test and monitor — but cannot change locked production mappings.

1. Feature Catalog → Environments (/environments), Gateway Smoke
2. Process Flows → Gateway export → smoke and *Scheduled run tick →
3. Feature Catalog → Drift Radar (/drift-radar) and
4. Role Permission Matrix → what production locks deny you and why.

#Tech Lead / Owner (default role: owner)

You own production locks, govern reviews, and decide what ships.

1. Feature Catalog → the Readiness Scorecard (/readiness) and its
2. Change Intelligence Appendix → the change-intelligence loop and
3. Process Flows → Mapping → review → lock and Readiness check → PDF.
4. Role Permission Matrix and GDPR.md → governance model

#Auditor / Viewer (default role: viewer)

You inspect, verify and export evidence — read-only.

1. Feature Catalog → Audit Log (/audit), Trust Center (/trust).
2. Process Flows → Evidence bundle export (audit-grade).
3. GDPR.md and trust/security-overview.md → the
4. Data Flow & Entity Reference → verify the zero-egress claim

#Procurement / Security reviewer

You assess risk before adoption.

1. GDPR.md → GDPR Art. 5 / 25 / 32 mapped to architectural answers.
2. ARCHITECTURE.md → the exactly-three outbound flows and the route map.
3. trust/security-overview.md and trust/DPA-template.md.
4. Data Flow & Entity Reference → the verifiable storage-key

#The whole app at a glance

The navigation groups every route. Use this as a map; each module has a full section in the
Feature Catalog, and the complete route tree is in
Navigation Tree.

flowchart TD
  subgraph WS[Workspace]
    O["/ Overview"]
    CAT["/catalog · Import"]
    EXP["/api-explorer"]
    GQL["/graphql"]
    RT["/realtime"]
    TMF["/tmf"]
  end
  subgraph MOD[Modeling]
    DP["/data-packs"]
    SC["/scenarios"]
    MAP["/mappings"]
    MR["/mapping-reviews"]
    ERR["/errors"]
    SD["/schema-diff"]
  end
  subgraph RUN[Runtime]
    ENVR["/environments"]
    PRE["/prevalidation"]
    EXEC["/execution"]
    GS["/gateway-smoke"]
    CI["/ci-gate"]
    SCH["/schedules"]
    MF["/mock-forge"]
  end
  subgraph INTEL[Intelligence]
    INS["/insights"]
    CHI["/change-intelligence"]
    OAI["/openai"]
    AEX["/explorer"]
  end
  subgraph RDY[Readiness]
    RScore["/readiness"]
    GOV["/governance"]
    SECP["/security-posture"]
    TR["/trace-readiness"]
    DR["/drift-radar"]
    VE["/validation-engine"]
    INV["/api-inventory"]
    RL["/resilience-lab"]
    AR["/agent-readiness"]
    CM["/compatibility-matrix"]
  end
  subgraph GOVN[Governance]
    AUD["/audit"]
    TRUST["/trust"]
    ENT["/enterprise"]
    SET["/settings"]
    HELP["/help · /docs"]
  end
  WS --> MOD --> RUN --> RDY
  RUN --> INTEL
  RDY --> GOVN

*Diagram: the navigation groups (Workspace, Modeling, Runtime, Intelligence, Readiness, Governance)
and the rough left-to-right lifecycle flow. Detail routes (/api/$apiId,
/api/$apiId/endpoint/$endpointId, advanced /import) and the public, full-bleed routes
(/welcome, /pricing) sit outside these groups.*

#Where to read these docs

• In the app: open the Documentation Center at /docs — it renders this exact docs
• In the repo / on GitHub: browse the docs/ folder. Start with this index, then follow
• Programmatically: the Help Menu masterfile lists every document

To learn how this documentation system is wired and how to extend it, see
docs/README.md.