Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Dmitry Sotnikov
Latest commit f523a1d Jun 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images Replace new file animation to full length Jun 17, 2019
LICENSE Initial commit Jun 5, 2019
README.md Add Go to Definition Jun 14, 2019

README.md

OpenAPI extension for Visual Studio Code

A Visual Studio Code extension with rich support for the OpenAPI (aka Swagger) language (v2 and v3 in JSON format), including features such as IntelliSense, linting, schema enforcement, code navigation, definition links, snippets, and more!

Quick Start

Open any JSON file that contains OpenAPI v2 or OpenAPI v3 definition in VS Code. The plugin should automatically detect that this is an OpenAPI file. When it does, the OpenAPI icon gets displayed in the left-hand panel.

OpenAPI navigation

  1. Open an OpenAPI file.
  2. Click the OpenAPI button at the left-hand pane to switch to the OpenAPI explorer view.
  3. Expand elements, click the elements to which you want to navigate in the editor.

Navigation inside OpenAPI / swagger file

Add elements from OpenAPI explorer

In the left-hand OpenAPI explorer pane, click the ... menu in the section where you want to add the element and pick the corresponding item from the menu.

Add new API path and verb

Intellisense

As you start typing OpenAPI elements and their values, context-relevant options get displayed in the intellisense menu. Just type double-quote (") to get it going.

Intellisense for OpenAPI editing

Go to definition

  • Ctrl-click a reference OR
  • Right-click a reference and click "Go to Definition" on the shortcut menu

Go to Definition

Create new OpenAPI files

  1. Press Ctrl-Shift-P on Windows or Cmd-Shift-P on a Mac.
  2. In the command prompt, start typing new openapi and then click the corresponding command to get v2 or v3 file created.
  3. The template file gets created. Use the OpenAPI explorer pane to populate it with new paths and other elements.

Create new OpenAPI file from template

Feedback

Submit your issues, questions, and feature requests to the GitHub project Issues.

You can’t perform that action at this time.