VOOZH about

URL: https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-apex-oas

⇱ Apex OpenAPI Specification - Visual Studio Marketplace

Skip to content
👁 Image
| Marketplace
Sign in
Visual Studio Code>Programming Languages>Apex OpenAPI SpecificationNew to Visual Studio Code? Get it now.
👁 Apex OpenAPI Specification

Apex OpenAPI Specification

Provides OpenAPI Specification generation for Apex REST and AuraEnabled classes
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Apex OpenAPI Specification Extension

This extension provides OpenAPI Specification (OAS) generation capabilities for Apex REST and AuraEnabled classes in Salesforce development.

Features

  • Generate OpenAPI Documents: Create OpenAPI v3 specifications from Apex classes annotated with @RestResource or @AuraEnabled
  • Validate OpenAPI Documents: Validate existing OpenAPI documents against Salesforce-specific rules
  • Spectral Validation: Uses Spectral to ensure compliance with OpenAPI standards and Salesforce best practices

Commands

  • SFDX: Create OpenAPI Document from This Class - Generate an OpenAPI document from an Apex class
  • SFDX: Validate OpenAPI Document - Validate an existing OpenAPI document

Requirements

  • Salesforce CLI extension
  • Apex extension
  • Agentforce Vibes extension (for AI-powered generation)
  • A Salesforce DX project with an authenticated org

Configuration

This extension contributes the following settings:

  • salesforcedx-vscode-apex-oas.general.class.access-modifiers: Class access modifiers eligible for OAS generation (default: ["global", "public"])
  • salesforcedx-vscode-apex-oas.general.method.access-modifiers: Method access modifiers eligible for OAS generation (default: ["global", "public"])
  • salesforcedx-vscode-apex-oas.general.property.access-modifiers: Property access modifiers eligible for OAS generation (default: ["global", "public"])
  • salesforcedx-vscode-apex-oas.generation_strategy: Strategy for OAS generation (default: "LEAST_CALLS")
  • salesforcedx-vscode-apex-oas.generation_include_schema: Include OpenAPI schema in generation (default: false)
  • salesforcedx-vscode-apex-oas.generation_output_token_limit: Maximum number of tokens for generation output (default: 750)

Dependencies

This extension depends on:

  • salesforce.salesforcedx-vscode-apex
  • salesforce.salesforcedx-vscode-core
  • salesforce.salesforcedx-einstein-gpt

Note: As of A4V v4.1.0 "Agentforce Vibes" (2026-06-13), the LLM integration required for OAS generation is temporarily unavailable. v4 removed the salesforcedx-einstein-gpt.isEnabled context key that gates the OAS commands' visibility (so they no longer appear) and the getLLMServiceInstance command that generation invokes. E2E tests are skipped pending migration off the A4V LLM service.

Activation

This extension activates on demand when you run one of its commands. It does not activate automatically at workspace startup.

Resources