Governance
Help & documentation
Short, technical, written for engineers. Every guide maps to one module — and everything described here ships in the app today.
Open the full Documentation CenterThe complete user manual, architecture, governance and trust docs — searchable, with diagrams, rendered offline from the in-app documentation set.
Start here
Quick start
First suite run in 5 minutes
- 1Settings → “Load public test APIs” adds four no-auth APIs (JSONPlaceholder, PokeAPI, Open-Meteo, REST Countries) with endpoints, environments, scenarios, mappings and an hourly smoke schedule. Open
- 2Open the Execution Console (G then E), pick a seeded scenario and press Run. Open
- 3Read the step-by-step trace: prevalidation, request, assertions — every step timed and recorded.
- 4Optional: Gateway Smoke runs the same scenarios against an exported gateway profile. Open
No account, no install — the demo workspace is already seeded.
Import
Four ways to bring a spec in
- 1File — drop an OpenAPI/Swagger JSON or YAML straight into the import wizard. Open
- 2URL — paste a spec URL; the only request goes to the address you typed. Open
- 3SwaggerHub — pull a published API by owner/name/version. Open
- 4Postman — convert a collection export into catalogued endpoints. Open
Every import gets a weakness report: missing enums, absent examples, vague descriptions.
Data residency & backups
Your workspace lives in this browser
- 1All state persists in localStorage — nothing is uploaded, ever. Verify on the Trust page. Open
- 2Settings → Portability exports the whole workspace as one bundle (optionally AES-256-GCM encrypted). Open
- 3Restore on any machine via merge or replace — encrypted bundles ask for their passphrase.
- 4Settings → Privacy & data shows the live key inventory and the erase-all-data control. Open
Browsers can clear storage — export a bundle before big cleanups.
Governance
Roles, reviews and locks
- 1Four roles — owner, editor, operator, viewer — with one-click impersonation in the topbar. Open
- 2Mapping changes flow through pending → approved / rejected / changes-requested. Open
- 3Mappings flagged as production are editable by owners only — locks live where the work happens. Open
- 4Every governance action lands in the append-only audit log. Open
Schema Diff impact reports export to PDF for the evidence file.
Module index — grouped like the sidebar
Workspace
3 modules
Modeling
6 modules
- Data PacksReusable request/response data sets that feed scenarios.
- ScenariosHappy paths, failures, malformed JSON and rate-limit rehearsals.
- Mapping StudioField-level mappings across APIs with live preview and a transform engine.
- Mapping ReviewsReview gates and production locks on every mapping change.
- Error LibraryStructured error cases ready to wire into scenarios.
- Schema DiffVersion diffs with endpoint/mapping/scenario impact, exportable as PDF or JSON.
Runtime
6 modules
- EnvironmentsBase URLs and auth profiles per API and stage.
- PrevalidationRule-based gates that stop bad requests before they leave.
- Execution ConsoleStep-by-step traces for every run — read the trace, not the tea leaves.
- Gateway SmokeSmoke-test exported gateway config (JSON / Kong YAML) against a profile.
- Scheduled RunsCron-style recurring runs with a notification log.
- Mock ForgeMock artefacts per endpoint and status code, driven by scenarios.
Intelligence
3 modules
Governance
3 modules
Keyboard
Shortcuts
| Keys | Action |
|---|---|
| Ctrl/⌘K | Open the command palette |
| / | Open the command palette (outside inputs) |
| GH | Go to Overview |
| GC | Go to API Catalog \ Import |
| GX | Go to API Explorer |
| GI | Go to Insights |
| GM | Go to Mapping Studio |
| GE | Go to Execution Console |
| GS | Go to Settings |
| ←→Esc | Navigate / close the product tour |
G-sequences: press G, then the letter within 1.5 seconds. They are disabled while typing in a field.
Support
An engineer answers the e-mail
No ticket portal, no chatbot maze. Describe what you tried and what happened; include your app version (footer of the sidebar) — never paste workspace data you consider sensitive.