VS Code Extension for flAPI

The flAPI VS Code extension provides an integrated development experience with syntax highlighting, validation, and testing—all without leaving your editor.

Features

🎨 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 params
• Run query and preview results
• Generate OpenAPI docs

📝 IntelliSense

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

Installation

Coming Soon

The VS Code extension is currently in development. Star our GitHub repository to get notified when it's released.

Manual Installation (Beta)

# Clone the extension repository
git clone https://github.com/datazoode/flapi-vscode
cd flapi-vscode

# Install dependencies
npm install

# Build and package
npm run package

# Install in VS Code
code --install-extension flapi-*.vsix

Usage

Validate Endpoint

1. Open an endpoint YAML file (e.g., sqls/customers.yaml)
2. Right-click in the editor
3. Select "flAPI: Validate Endpoint"
4. See validation results in the output panel

Test Template

1. Open a SQL template file (e.g., sqls/customers.sql)
2. Right-click in the editor
3. Select "flAPI: Expand Template"
4. Enter test parameters in the input dialog
5. See expanded SQL in a new tab

Preview Results

1. Open an endpoint YAML file
2. Click the "▶ Run Query" code lens above the file
3. Enter test parameters
4. See query results in a table view

Configuration

Add to your VS Code settings (.vscode/settings.json):

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

Keyboard Shortcuts

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

Snippets

The extension includes snippets for common patterns:

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

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.