Nifty OpenAPI
Edit OpenAPI and Swagger files with an outline, $ref navigation and completion, error checking, example payloads, and Try it requests for your REST client.
Maintained. No sign-in. No telemetry. Works in VS Code, Cursor, Windsurf, VSCodium and other editors that use Open VSX.
Features
- Works on your spec files as they are. OpenAPI 3.0/3.1 and Swagger 2.0, YAML or JSON. Any file that starts with
openapi: or swagger: gets these features; nothing to configure.
- Outline and breadcrumbs for info, every path and its operations (with their summaries), and components grouped by kind. Go to Operation… (
Ctrl+Alt+O) jumps to any endpoint by method, path, operationId or summary.
$ref like a real language.
- Go to Definition on a
$ref, including refs into other files (./schemas/user.yaml#/User).
- Hover to preview what a
$ref points to.
- Completion of
#/components/... refs.
- Find All References on a schema, parameter or response.
- Rename a component and every
$ref to it is updated.
- Catch mistakes early:
$refs that don't resolve, duplicate operationIds, operations without responses, {pathParams} that aren't declared, and components that nothing uses (faded out).
- Try it. A link above every operation writes a ready-to-send request into a
.http file next to the spec, with the server URL, path parameters, required query parameters and a sample JSON body filled in. Send it with Nifty REST Client or any REST client that reads .http files.
- Example payloads. Example above every schema and response shows a realistic sample JSON, using
example, default and enum values and following $ref, allOf and oneOf.
- Works in the browser on vscode.dev and github.dev.
Commands
| Command |
What it does |
Nifty OpenAPI: Go to Operation… |
Jump to an endpoint (Ctrl+Alt+O) |
Nifty OpenAPI: Try an Operation (write a .http request)… |
Write a request you can send |
Nifty OpenAPI: Show Example JSON |
Sample JSON for the schema under the cursor |
Settings
| Setting |
Default |
What it does |
nifty.openapi.codeLens |
true |
Show Try it and Example links |
nifty.openapi.reportUnusedComponents |
true |
Fade out unused components |
nifty.openapi.baseUrl |
"" |
Base URL for Try it (empty uses the spec's first server) |
Install
- VS Code: search for "Nifty OpenAPI" in the Extensions view, or install from the Visual Studio Marketplace.
- Cursor, Windsurf, VSCodium, Kiro, Antigravity: install from Open VSX.
Privacy
This extension collects no telemetry and needs no account.
- Nifty REST Client: .http Files & HTTP Requests: Send HTTP requests from .http files: variables, environments, request chaining, response viewer, cURL import and export, and history. No account, no cloud. (Open VSX)
- Nifty YAML: Formatter, Validator & Converter: Format YAML without losing comments (Kubernetes-style indents), sort keys, lint with yamllint, copy the key path, and convert to and from JSON. (Open VSX)
- Nifty Data Pack: 9 Nifty extensions for working with JSON, YAML, XML, CSV, SQL and spreadsheets: JSON, YAML, XML, SQL, Data Viewer, SQLite, Spreadsheet Viewer, Paste JSON as Code, Mermaid. (Open VSX)
- Nifty Paste JSON as Code: JSON to Types: Turn JSON on your clipboard into types for TypeScript, C#, Go, Rust, Python, Java, Kotlin, Swift, Dart and more. (Open VSX)
- Nifty Pretty Errors: Readable Error Messages: Readable error messages for every language: TypeScript types formatted as code, long C++ and Rust types folded, and a docs link for every error code, in the hover and a side panel. (Open VSX)
- Nifty Problems: Project-Wide TypeScript Errors: See TypeScript and ESLint errors for your whole project in the Problems panel, not just open files. (Open VSX)
See all 100+ Nifty extensions and web tools at https://getnifty.dev
| |
