Interface Overview
Interface Overview
Overview
This guide explains the main parts of the VSCode OpenAPI spec generator interface.
The overall layout is built around a guided generation flow, helping you move from selecting an OpenAPI specification to choosing the generator type, adjusting options, configuring extraction, and generating code.
Header Area
From here, you can see:
- view the current subscription status badge
- see whether premium or licensed features are active
Wizard Navigation Area
The wizard navigation area appears near the top of the main content.
This area shows the step-by-step flow used by the interface:
- Spec
- Target
- Options
- Extraction
- Review
From here, you can:
- see which step is currently active
- move back to previously completed steps
- understand which steps are still required before generation
This makes the interface predictable and helps you follow the full generation process in the right order.
Specification Area
The specification area is the first step of the wizard.
This area lets you:
- select an OpenAPI specification file
- browse for
.yaml,.yml, or.jsonfiles - load a specification from the VS Code workspace or from disk
- see the currently selected specification path
This is where every generation starts, because the rest of the interface depends on the selected spec.
Generator Type Area
The generator type area is the second step of the wizard.
This area lets you:
- choose whether you want to generate a client or a server
- switch generator type before continuing
This step defines the kind of output the tool will request from the generator service.
Language and Options Area
The language and options area is the third step of the wizard.
This area lets you:
- choose the target language
- open the settings dialog for generator-specific options
- see when options have been changed from their defaults
- choose the generator version or environment for certain generators
This is the main configuration area for generation behavior.
Supported generators (For ABL)
Languages example
Extraction Settings Area
The extraction settings area is the fourth step of the wizard when the tool runs inside VS Code.
This area lets you:
- choose the project path where generated output should be extracted
- decide whether the generated ZIP should be extracted automatically
- review the list of excluded files that should not be overwritten
This step controls where the generated result goes after generation finishes.
Review and Generate Area
The review and generate area is the final step of the wizard.
This area gives you a summary of:
- the selected specification
- the generator type
- the chosen language
- the selected API environment
- the extraction mode
- how many generator options are configured
From here, you can:
- review the final configuration before generation
- see when saved settings will be updated
- start the code generation process
This is the final checkpoint before the tool calls the generator service.
Load saved Settings Area
The saved settings action is available above the main wizard content.
From here, you can:
- open the list of previously saved generation settings
- reload a saved client or server configuration
- restore the spec path, language, options, and extraction settings for a previous generation setup
This helps you return quickly to common generation scenarios without rebuilding the configuration manually each time.