WSO2 API Designer
What WSO2 API Designer is
WSO2 API Designer is a Visual Studio Code extension for creating and improving OpenAPI specifications. It supports OpenAPI 3.x files in YAML or JSON, with a design view for API resources, operations, and reusable components. Form-based editing covers operations and schemas. An API Design Skill can work with GitHub Copilot to draft specifications from prompts; Copilot is optional and recommended for AI-assisted workflows. Bundled Spectral rulesets check specifications for WSO2 AI readiness, WSO2 REST API design guidance, and the OWASP API Security Top 10. AI-assisted analysis adds narrative feedback to rule-based findings. Users can point the extension to a custom ruleset folder through a GitHub URL or absolute local path. The documented prerequisite is a VS Code extension engine compatible with ^1.100.0. Installation is available from the VS Code Marketplace, and support is directed to WSO2’s Discord community. The 30-day trial costs nothing; Growth costs $119 a month.
Who it suits
WSO2 API Designer suits developers building OpenAPI specifications in Visual Studio Code, including users who want form editing, governance checks, or optional Copilot drafting. It also fits teams using custom rulesets.
What it does well
- Supports OpenAPI 3.x YAML and JSON
- Provides visual specification editing
- Checks OWASP API security guidance
- Supports custom ruleset folders
- Available in a 30-day trial
What to know first
- Requires compatible VS Code extension engine
- Copilot is optional, not included as required
- Security findings may need real production metadata
- Growth plan costs $119 a month
Limits
The 30-Day Trial is limited to 5 Managed Interfaces and 10M Gateway Events. Growth allows up to 10 Managed Interfaces and up to 10M Gateway Events; Enterprise uses custom limits.
Plans
| Plan | Billed and limits | Price |
|---|---|---|
| 30-Day Free Trial | 30-day free trial · 5 managed APIs · 1M API gateway events · 1M maximum API requests per month | On request |
| 30-Day Trial | 5 Managed Interfaces · 10M Gateway Events · API Designer available | Free |
| Growth | from $119 /mo · Up to 10 Managed Interfaces · Up to 10M Gateway Events · API Designer available | $119 a month |
| Enterprise | Custom · Custom limits · Self-hosted available · Federation · Private Data Plane · Enterprise Support · API Designer available | On request |
As wso2.com lists them, read 20 Sept 2026. The maker's own page has the final word.
Getting started
- Open the WSO2 API Designer documentation website
- Use a compatible Visual Studio Code installation meeting extension engine requirement ^1.100.0
- Install the extension from the VS Code Marketplace
- Open an OpenAPI 3.x YAML or JSON specification
- Use the design view or form-based editors
- Optionally connect GitHub Copilot or select a custom ruleset folder
Verdict
WSO2 API Designer adds visual editing, governance rules, and optional AI assistance to OpenAPI work in VS Code. Its prerequisite version, metadata cautions, and paid Growth plan are important before adoption.
Questions
Is WSO2 API Designer free?
The pricing model is free, with an open-source note and a 30-day trial. The listed Growth plan costs $119 a month, while Enterprise pricing is custom.
Does it have a free plan?
No free plan is listed, but a 30-day trial is available free of charge.
Which specification formats does it support?
It supports OpenAPI 3.x specifications and opens YAML or JSON files.
Does it work with GitHub Copilot?
Yes. Its API Design Skill can draft API specifications from prompts with GitHub Copilot, which is optional and recommended for AI-assisted workflows.
Where can it run?
Listed platforms are extension, Linux, macOS, web, and Windows. Installation is offered through the VS Code Marketplace.
Is it self-hosted?
The deployment model is self_hosted, and Enterprise lists self-hosted availability.
Facts from WSO2 API Designer's own pages
- AI design
- The extension includes an API Design Skill that works with GitHub Copilot to draft API specifications from prompts. · wso2.com, 3 Oct 2026
- AI readiness
- AI-assisted analysis combines rule-based results with narrative feedback about specification issues that can affect agents and tools. · wso2.com, 3 Oct 2026
- Custom rules
- Users can point the extension to a custom ruleset folder using a GitHub folder URL or an absolute local directory path. · wso2.com, 3 Oct 2026
- Founded
- 2005 · wso2.com, 28 Sept 2026
- Governance
- It checks specifications with bundled Spectral rulesets for WSO2 AI readiness, WSO2 REST API design guidelines, and OWASP API Security Top 10. · wso2.com, 3 Oct 2026
- Integration
- GitHub Copilot is optional and recommended for AI-assisted workflows; the extension can be installed from the VS Code Marketplace. · wso2.com, 3 Oct 2026
- Intended users
- WSO2 describes its 30-day trial as ideal for students and individual developers, and its Growth plan as intended for small to mid-sized businesses with basic API management needs. · wso2.com, 3 Oct 2026
- Maker security
- WSO2 states that it is ISO 27001:2022 certified and SOC 2 Type 2 compliant. · wso2.com, 3 Oct 2026
- Purpose
- API Designer is a Visual Studio Code extension for building and improving OpenAPI specifications. · wso2.com, 3 Oct 2026
- Requirement
- The documented VS Code prerequisite is compatibility with extension engine requirement ^1.100.0. · wso2.com, 3 Oct 2026
- Security note
- WSO2’s API Designer guidance warns that security findings may require real URLs, policies, or authorization server metadata and advises against inventing production values with AI. · wso2.com, 3 Oct 2026
- Specification format
- API Designer supports creating and improving OpenAPI 3.x specifications and opens YAML or JSON specification files. · wso2.com, 3 Oct 2026
- Support
- The documentation directs users to WSO2’s official Discord community for help and discussion. · wso2.com, 3 Oct 2026
- Visual editing
- Design view displays API resources, operations, and reusable components and supports form-based editing of operations and schemas. · wso2.com, 3 Oct 2026
Where WSO2 API Designer stands on Freedom251
- API Design Tools#25 of 26