Skip to content

VS Code extension

The Restura for VS Code extension makes OpenCollection files first-class citizens of your repo. It deliberately does only what an editor does better than a separate GUI: structured editing, a native Test Explorer, and inline send — all over the same files your team already commits. The design is in ADR 0025.

  • Schema validation of request files (http / grpc / graphql / websocket) against the OpenCollection element schemas — squiggles on missing or invalid fields, located to the offending line.
  • Autocomplete + hover on root opencollection.{yml,yaml} files via the bundled JSON Schema (requires the Red Hat YAML extension; request-file validation works without it).

Your collections appear in VS Code’s native Testing view, mirroring the folder structure. Run the whole collection, a folder, or a single request — pass/fail, durations, and assertion details show inline. Runs shell out to the restura CLI, so local results match CI exactly.

CodeLens actions above each request:

  • ▶ Send (HTTP/GraphQL) — sends through Restura’s shared protocol core (SSRF guard, header policy, redirect handling, wire-level auth) and shows the response in a side panel. Variables resolve from the collection’s default environment.
  • ▶ Run test — runs just that request through the CLI and reports assertions.
  • The restura CLI on PATH or in your workspace node_modules (used by the Test Explorer and Run test). Override the path with restura.cliPath.
  • Node.js 24+.
  • Trusted, local workspaces only — the extension spawns a CLI and makes network requests, so it doesn’t run in virtual or untrusted workspaces.
SettingDefaultDescription
restura.cliPath""Path to the restura binary (auto-resolved if empty).
restura.allowLocalhosttrueAllow Send/test runs to target localhost.
restura.allowPrivateIPsfalseAllow private/RFC-1918 targets. Cloud-metadata endpoints stay blocked.
restura.env""Optional env file (JSON/YAML) passed to the CLI runner.

Two further offerings are scoped but not yet shipped: OpenAPI contract drift (generate requests from a spec and flag drift) and one-click MCP registration (register Restura’s MCP server into the workspace MCP config).