OpenAPI Generator

Manuels

Manuels

Consultez les manuels liés à vos installations et à votre compte.

Quick Start

VSCode OpenAPI spec generator — Quick Start

Generate client or server code from OpenAPI specs without leaving VS Code. <br/> This extension opens a dedicated OpenAPI generator UI inside VS Code, reads .yaml / .yml / .json specs, and can extract generated code directly into your workspace.


Prerequisites

RequirementDetails
VS Code1.101 or newer
Internet accessRequired for login, license validation, and calling the remote OpenAPI generator service
OpenAPI specA valid .yaml, .yml, or .json OpenAPI file

Install

Install OpenEdge ABL - OpenAPI from the VS Code Marketplace or from the .vsix file.

install.png
install.png

Configure project settings

The extension stores generation settings in VS Code under ai4you-openapi.projectGenerationSettings.

You usually do not need to edit this manually because the UI saves and reloads these settings for you. If needed, you can define them in .vscode/settings.json.

Workspace-folder scope example:

{
  "ai4you-openapi.projectGenerationSettings": {
    "_globalWorkspacePath": "C:/work/my-project",
    "_globalAblApiEnvironment": "2026q1",
    "excludeFiles": ".git,.gitignore"
  }
}

Common values used by the extension:

SettingPurpose
workspacePath / _globalWorkspacePathTarget path where generated code should be extracted
excludeFilesComma-separated file patterns to avoid overwriting during extraction
ablApiEnvironment / _globalAblApiEnvironmentSelects which OpenAPI generator environment to use
licenseDataStored license information used after validation

Open the OpenAPI generator

Three quick ways to launch it:

  1. Open the command palette.
  2. Run Launch OpenAPI generator 😎 (vscode sync).
  3. Use the OpenAPI generator webview that opens inside VS Code.
launch openAPI generator.png
launch openAPI generator.png

On first use, the extension may prompt you to register its MCP server for AI-assisted workflows.


Generate code from a spec

Typical flow:

  1. Launch the OpenAPI generator.
  2. Select an OpenAPI spec file (.yaml, .yml, or .json).
  3. Select whether you want a client or server generator.
  4. Choose an available language and generator version.
  5. Change configuration options if needed.
  6. Choose whether to extract the generated ZIP into your project path.
  7. Generate the code.

When extracting into a folder, the extension respects the configured excludeFiles list for existing files.

What you can do

  • Open an interactive OpenAPI generator UI inside VS Code.
  • Select local OpenAPI specification files from your workspace or disk.
  • Generate client or server code for supported languages.
  • Extract generated ZIP output directly into your project folder.
  • Save and reload per-project generation settings.
  • Switch between configured generator environments.
  • Use MCP integration for AI workflows that depend on the OpenAPI generator.

Demo

Ouvrir la video dans un nouvel ongletVideo: demo.mp4
demo.mp4