VS Code Extension for flAPI

Preview / Roadmap

The flAPI VS Code extension is not yet released. The repository (extensions/vscode/) contains a work-in-progress and the matching vscode-build / vscode-dev Makefile targets exist in flapi, but no packaged .vsix is published yet.

The feature list, settings keys, keyboard shortcuts, and snippet names on this page describe planned behavior. They will be confirmed (or revised) when the first preview build ships. Until then, use the flapii CLI for validation, template expansion, and runtime configuration.

The flAPI VS Code extension is intended to wrap the flapii CLI to provide an in-editor development experience for flapi.yaml, endpoint YAML, and Mustache SQL templates.

Planned Features

Planned — not yet implemented

The items below describe the target feature set. Capabilities, names, and bindings are likely to change before the first release.

Syntax Highlighting

• YAML configuration files
• SQL templates with Mustache syntax
• Inline validation errors

Real-Time Validation

• Endpoint configuration errors highlighted
• SQL syntax checking
• Connection verification
• Parameter validation

Quick Actions

• Validate endpoint (right-click)
• Expand template with test parameters
• Run a test query and preview results

IntelliSense

• Auto-complete for configuration fields
• Parameter suggestions
• Connection name completion
• Mustache template helpers

Installation

The extension is not on the Marketplace yet. To follow progress or build from source, check the extensions/vscode/ directory in the flAPI repository and the vscode-build / vscode-dev Makefile targets:

git clone --recurse-submodules https://github.com/DataZooDE/flapi.git
cd flapi
make vscode-build

Star the GitHub repository to get notified when the first preview is published.

Planned Configuration

Planned — subject to change

The settings keys below are placeholders for the upcoming extension and are not yet read by anything.

{
  "flapi.configPath": "./flapi.yaml",
  "flapi.validateOnSave": true,
  "flapi.showQueryResults": true,
  "flapi.maxResultRows": 100
}

Planned Keyboard Shortcuts

Planned — subject to change

The shortcuts below have not been finalized and may change before the first release.

Action	Shortcut (Mac)	Shortcut (Windows/Linux)
Validate Endpoint	Cmd+K Cmd+V	Ctrl+K Ctrl+V
Expand Template	Cmd+K Cmd+E	Ctrl+K Ctrl+E
Run Query	Cmd+K Cmd+R	Ctrl+K Ctrl+R

Planned Snippets

Planned — subject to change

Snippet identifiers below are tentative and not yet shipped.

• flapi-endpoint: Scaffold a new endpoint
• flapi-cache: Add cache configuration
• flapi-auth: Add authentication
• flapi-validation: Add parameter validators

In the meantime

Everything the extension is planned to do is available today through the CLI:

flapii endpoints validate /customers
flapii templates expand /customers --params '{"id":"123"}'
flapii endpoints reload /customers

See flapii CLI for the full command surface.

Next Steps

• CLI Overview: Learn about the command-line tools
• Configuration Service: Advanced configuration management
• Quickstart Guide: Build your first API
• Configuration Guide: Learn all options
• SQL Templating: Master Mustache syntax
• Build from Source: Compile and develop locally
• Contributing: Contribute to the extension

Want help setting up your development environment? Contact us.