Vizroute user guide
What Vizroute does, which part to open for which job, and what happens to the specifications you give it.
Vizroute turns an API specification into a map you can read. From the map you can send real requests, audit the specification, compare two versions of it and hand it on as docs, an image or a link. It runs in your browser tab. The specification is read there, not on a server.
This guide covers every part of the product as it works today, including what it does not do. Each page stands on its own, so jump to the one you need.
The three parts
| Part | Address | Use it for | Account |
|---|---|---|---|
| API Map | /workspace | One specification: the map, the request playground, audit, diff, docs and export | Not needed |
| Contract Graph | /graph | Many services on one map, to find overlap and dependencies between them | Needed |
| Explore Tools | /tools | Single-purpose pages, such as a JSON formatter or a JSONPath tester | Not needed |
A fourth part, the SOAP Migration Workbench, exists but is switched off on most sites. Its page explains how to tell.
Where your data goes
- Specifications are read and drawn in your browser. Nothing is uploaded when you open one.
- Requests you send from the playground go to the API you are testing.
- Share links carry the specification inside the link, after the
#. Browsers do not send that part to any server, but anyone you give the link to can read the specification. - The AI assistant is off until an OpenRouter key is set. When you use it, your specification goes to OpenRouter.
- Saved work such as recent APIs, collections and Contract Graph workspaces stays in this browser. Text pasted into a tool page is never saved.
The full list is on Accounts and privacy.
In this guide
- Getting started: open the app, load a file and read your first map.
- API Map: everything you can do with one specification.
- Explore Tools: the six standalone JSON tools.
- Contract Graph: many services on one map, and what the findings mean.
- SOAP Workbench: turning a WSDL into a REST design, where the site has it on.
- Accounts and privacy: local and connected accounts, and where saved work lives.
- Limits and FAQ: what it does not do, size limits, and fixes for common problems.
Conventions
Button and tab names are written in bold, exactly as they appear on screen. Addresses and file names are in code. Keyboard shortcuts say Ctrl; on a Mac, use the Command key instead.