API Designer for Visual Studio Code

API Designer is an OpenAPI-first extension for designing and analyzing API specifications directly in VS Code.

Quick Start

1. Install the API Designer extension from the VS Code marketplace
2. Open an OpenAPI YAML file.
3. Open the visual designer using any of these entry points:
   • The Open in API Designer CodeLens
   • The preview icon in the editor title bar
   • The Command Palette: API Designer: Open In API Designer

Features

Design OpenAPI Specs

• Visual editor for OpenAPI 3.x specifications.
• Edit paths, operations, request bodies, responses, parameters, headers, and reusable components.
• Use GitHub Copilot with API Designer to generate and refine API designs from prompts.

Analyze Governance and AI Readiness

• Validate specs with Spectral-based governance reports.
• View categorized issues, severity breakdowns, and report scores.
• Evaluate API AI readiness with guided AI-assisted analysis.

Ruleset Support

• Built-in default governance rulesets:
  • WSO2 REST API AI Readiness Guidelines
  • WSO2 REST API Design Guidelines
  • OWASP API Security Top 10

APK Configuration Support

• Schema validation, auto-completion, and error checking for APK configuration files (.apk-conf).
• Create new APK configuration files from built-in templates (Basic, Petstore, Pizza Shack) via the Command Palette: API Designer: Choose Template (APK).
• Requires the YAML Language Support by Red Hat extension (installed automatically if not present).

Resources

• OpenAPI Specification
• Spectral Documentation

License

Copyright (c) 2026, WSO2 LLC. (https://www.wso2.com) All Rights Reserved.

Licensed under the Apache License, Version 2.0. See LICENSE for details.

Built by WSO2