ApiView

VS Code extension that visualizes an OpenAPI (3.x / Swagger 2) YAML or JSON file: every endpoint, grouped by tag, with its parameters, request body and response schemas ($refs resolved). AsyncAPI (2.x / 3.x) files are shown the same way, one entry per channel (MQTT topic) with its messages' headers and payload schemas.

Use

Open a spec file and run ApiView: Preview (command palette, editor title button, or right-click). The panel updates as you edit. Filter box matches method, path, summary, operationId and tag.

The ApiView activity-bar view ({..} icon) lists the active spec's endpoints by tag: click one to open it in the preview, or use the inline button to jump to its definition in the source.

The ☆ in the preview's top-right corner stars the spec (it turns into a yellow ★). Starred specs are listed by file name in Favorites at the top of the same view (hover for the workspace-relative path); click one to open its preview, or use the inline ✕ to remove it. Favorites are per workspace.

Each endpoint has a Try it section: parameters and the JSON body as a form prefilled with defaults/examples (dropdowns for enums and booleans, limits from the schema are validated), a base address and Send. The base address is remembered per spec file (initially servers[0].url). Requests are sent by the extension host, so under Remote-SSH they leave from the remote machine (install the extension in the SSH host when VS Code offers). Form edits reset when the spec is edited.

For AsyncAPI files each channel has a Subscribe section instead: a broker URL (mqtt://, mqtts://, ws://, wss://; initially from the first server, remembered per spec file), the topic (prefilled from the channel address, {param}s become +) and a Subscribe / Unsubscribe toggle. Received messages are listed newest first (JSON pretty-printed). Like HTTP requests, the MQTT connection runs in the extension host; subscriptions are dropped when the spec is edited or the preview is closed.

Examples

Build

npm install
npm test            # compile + self-check
npm run package     # produces apiview-<version>.vsix
code --install-extension apiview-0.2.2.vsix

Press F5 in this folder to run it in an Extension Development Host.

Limitations: only local #/... refs (no external files); AsyncAPI is subscribe-only (no publish) and message traits are not merged into the shown headers.

Bump version

# Bug fixes, small changes
npm version patch
# New features
npm version minor
# Breaking changes
npm version major
# Custom
npm version <new version>