OpenAPI Tools for Visual Studio Code
This Visual Studio Code (VS Code) extension adds rich support for the OpenAPI Specification (OAS) (formerly known as the Swagger specification). The plugin supports code navigation, linting, SwaggerUI or ReDoc preview, IntelliSense, schema enforcement and generation, schema definition links, snippets as well as static and dynamic security analysis.
If you are a 42Crunch customer or have an account of a 42Crunch platform, you can also directly access API collections and security reports through the integrated platform navigator.
Both OAS v2 and v3.0.x are supported, in JSON or YAML format.
After installing the plugin, open any JSON or YAML file that contains an OpenAPI definition. The plugin automatically detects that this is an OpenAPI file, and the /API button is shown in the left-hand panel.
We also encourage you to watch this video that gives you a full tour of the editor and its different features.
This extension makes it easier and faster to navigate your OpenAPI definitions, especially when they get longer.
You can home in on elements in the OpenAPI explorer view, or jump directly to the target of a reference in the API. You can also add new elements to your API directly in the OpenAPI explorer directly where they are needed. Filling in the details is quicker with IntelliSense support for OpenAPI elements.
Creating OpenAPI files
- Press Ctrl+Shift+P on Windows or Linux, or Cmd+Shift+P on a Mac.
- In the command prompt, start typing
new openapi, and click the corresponding command to create either an OAS v2 or v3 template file.
- Use the OpenAPI explorer to populate the template with new paths and other elements as needed.
- Save the file to your disk to fully enable IntelliSense.
Watch this video on editor basics.
Navigating an API definition
- Open an OpenAPI file.
- Click the OpenAPI button to switch to the OpenAPI explorer view.
- Expand the sections and elements in the file as needed, and click the ones you want to jump to in the editor.
Add new elements in the OpenAPI explorer
- In OpenAPI explorer pane, go to the section where you want to add a new element and right on the relevant node to open a context menu.
- Click the item you want to add from the dropdown list.
As you start typing OpenAPI elements or their values, the context-sensitive list of available options is displayed in the IntelliSense menu. In JSON OpenAPI files, just type double-quote (
") to show the menu, and type further to filter the list. In YAML OpenAPI files, start typing the property name.
You can also use the corresponding VS Code hotkey (Ctrl+Space on Windows, Cmd+Space on Mac) to open the IntelliSense menu.
Jump to a reference
Use Go to Definition to locate the targets of references easily. To jump to view the definition from a reference in your API, either Ctrl+click a reference, or right-click a reference and click Go to Definition in the shortcut menu.
Sort entries in the navigation pane
By default, entries in the OpenAPI Explorer pane are sorted alphabetically. If you want to instead have them sorted in the order they are in the OpenAPI file, change the corresponding setting:
- On the File menu, click Preferences > Settings.
- Expand the Extensions section and click OpenAPI.
- Clear the checkbox Alphabetically sort contents of OpenAPI explorer outlines.
Preview OpenAPI documentation
To change the default OpenAPI Preview rendering engine:
- On the File menu, click Preferences > Settings.
- Expand the Extensions section and click OpenAPI.
- Pick the option of your choice from the Default Preview Rendered dropdown list.
Execute operations with "Try it"
With "Try it", you can invoke operations defined in your OpenAPI directly from VS Code:
- Click on "Try it" in the code lens which is displayed right below the HTTP verb (e.g. "get", "post") of your operation and in the examples section.
- The payload data will be generated based on the request JSON Schema, or the first example available. You can edit this information before sending the request.
Try it comes with a number of limitations:
- Sending files is not supported
- It works best with text-based responses, such as JSON
- Binary/image responses will be shown as text
Generate JSON schemas based on the response content
"Try it" can be used to generate JSON Schema based on the body of the response.
- Select "Tools" tab in the TryIt response
- Click "Generate schema" button.
Static API Security Testing
You can use this OpenAPI extension to check the quality and security of your API definition as you work on it. This feature is powered by 42Crunch Audit. 42Crunch Audit performs a static analysis of the API definition that includes more than 300 checks on best practices and potential vulnerabilities related to authentication, authorization as well as data constraints.
Watch this video to learn more about 42Crunch Audit.
You can run the audit service in freemium or platform mode:
- Using our freemium centralized service: this service is a fully featured version of the audit, but with usage limits. In this mode, OAS files are sent to the service, audited and a report is returned. This is a stateless service: we do not keep the OpenAPI file, nor the report.
- New! Using the 42Crunch CLI: in this mode, audits are performed locally (on the user's machine). This is only available to freemium users for now. Support for local audit/scans using a platform API token will be available soon. In this mode, OpenAPI files and reports are kept locally.
- Using 42Crunch SaaS platform: this requires an account on a 42Crunch platform, which is available to customers and to prospects evaluating our product. In this case, you need to supply your platform URL and an IDE token (which can be created from the platform home page). You can specify those settings by invoking
42Crunch: Update platform credentialsfrom the command palette.
Getting a Freemium Token
To run Security Audit from VS Code, you need a token. The first time you try to audit or scan an API, you are asked to provide your email address or an API token from the platform.
Once you supply the address, the extension requests the token to be sent to your mailbox. Paste the token you received in the prompt in VS Code, and you are all set.
Running an audit
You can use OpenAPI extension to check the quality of your API as you work on it. You can run the audit directly from VS Code by clicking the 42C button in the upper right corner. Alternatively, you can run an audit for an individual endpoint.
Navigating the issues in the audit report
After the audit finishes, you get the audit report directly in the VS Code view, side by side with your code. The report viewer provides handy ways to navigate the found issues, even if the report is quite long.
Look here for issues that require the most attention.
- Most Common issues: this list contains issues that are occuring the most, and how many times they are repeated.
- Opportunities: this list contains issues that, if fixed, will most contribute to raise the audit score.
Those two lists will often overlap and in certain cases be identical, but this is totally normal.
Full issue list
The full issue list contains all issues found. The list can be filtered in two ways:
- Using the security gate (SQG) toggle: an SQG enforces enterprise compliance and hightlights issues that are offending the requirements established, such as a minimal score, issues severity or specific issues (e.g. an API key is used when only OAuth is allowed across the enterprise). When the toggle is on, only the issues affecting the SQG status are shown.
- Using the filtering options: you can also use filtering options to drill-down into the list such as severity, category or even a specific issue type.
For each issue, you have access to full information about the issue, why it is relevant and recommendations on how to address the issue.
Watch this video to learn more about audit and how to navigate issues.
Many of the issues reported by 42Crunch Audit have fixes associated with them. These are code snippets that you can insert into the OpenAPI file and then customize with the appropriate value.
- Cick some of the error lines in your OpenAPI file to bring up the QuickFix blue icon on the left of the line.
- Click the Quickfix icon and select the fix to apply.
- Tweak the values in the inserted code snippet as you see fit.
(New!) Dynamic API Security testing
42Crunch Audit performs a security analysis that does not require any live API, just the definition itself. 42Crunch Scan leverages the OpenAPI definition to:
- Test the resilience and behavior of APIs by automatically generating security tests from the APIs' OpenAPI definition. Scan reproduces the typical behavior of a hacker by injecting bad payloads, bad tokens, and using invalid HTTP verbs and paths. This helps detect vulnerabilities early in the API life cycle, especially those associated with the OWASP API Security Top 10.
- Validate that the implementation of the API conforms to its established contract: Scan checks all responses against the OpenAPI definition and detects unexpected responses and data leaks.
Watch this video to learn more about 42Crunch Scan.
APIs which thoroughly enforce compliance to an established contract are far more resilient to all types of attacks.
Launching 42Crunch Scan
Scans are run at the operation level only. We recommend you use the 42Crunch CLI to run scans. The alternative is to run a docker image locally. 42Crunch customers can also leverage our scand manager, by deploying an API-driven scan engine on Kubernetes.
In order to run a scan, you will need :
A credential : most likely, your API is using some form of authentication, like an API Key or token. You need a valid credential to provide to the scan engine.
The URL when the API is deployed.
We strongly recommend that you do not target a production system. While the tool does not try to inject malicious payloads, it is possible that the API implementation is not resilient enough to handle the tests and may crash or behave unexpectedly.
When you first launch a scan, you are presented with the scan configuration viewer. The scan configuration is generated automatically from the OpenAPI file you chose to scan.
For each operation in the OpenAPI file, a request is created. You can test individual requests using the Try button top-right.
Requests can be arranged into testing scenarios: a scenario combines one or multiple requests, for example you need to create a resource before you can view it. The editor allows you to extract data as variables from a request execution to inject it into the next step.
Similarly to requests, you can test an individual scenario to ensure it is built correctly before starting a scan: the scan engine will execute the scenario and if successful, launch automatically dozens of tests using the data provided in the OpenAPI file. The scan will send bad verbs, bad data types, bad data formats as well as authentication tests.
Once the scan has run, you are presented with a results page. The summary shows if the scan got a testing baseline by running the HappyPath test. Additional testing results are visible from the tests list. For each issue, you can easily reproduce the problem using a curl request.
- You can load results of Security Audit from a file for a currently open OpenAPI file by running command
42Crunch: Load Security Audit report from filefrom the command palette
To execute the 42Crunch Freemium services, you need access to the following URL: https://stateless.42crunch.com. You may need to ask your administrators to add a firewall rule to allow the connection.
- For new files, IntelliSense does not work until you save the file. File extension must be
- When running 42Crunch Scan on a host with incorrect clock, the scan can fail with the message
cannot send the scan report : rpc error: code = InvalidArgument desc = invalid input, to resolve the issue make sure your clock is correctly set.
Submit your bug reports at GitHub project Issues.
And, needless to say, your reviews at VS Code marketplace mean the world to us!