APiGen IDE Plugins

IDE plugins and tooling for APiGen - Multi-Language API Generator with enhanced development experience, auto-completion, and real-time validation.

Overview

The Problem: Manual Configuration Files

Before APiGen IDE Plugins:

// Manually write apigen.json with no help
{
  "name": "my-api",
  "langauge": "java-srpng",  // ❌ Typo not detected
  "databse": "postrgesql",   // ❌ Typo not detected
  "feautres": [              // ❌ Typo not detected
    "jwt-auth",
    "graphQL",               // ❌ Wrong case, should be "graphql"
    "invalid-feature"        // ❌ Non-existent feature, no warning
  ]
}

After APiGen IDE Plugins:

// VS Code/IntelliJ/Eclipse with APiGen plugin:
{
  "name": "my-api",
  "language": "java-spring",  // ✅ Auto-completed from dropdown
  "database": "postgresql",   // ✅ Typo prevented by suggestions
  "features": [               // ✅ IntelliSense shows 100+ features
    "jwt-auth",               // ✅ Hover shows: "JWT authentication with access+refresh tokens"
    "graphql",                // ✅ Auto-corrected from "graphQL"
    "rate-limiting"           // ✅ Only valid features suggested
  ]
}

Supported IDEs

IDE	Status	Installation
VS Code	✅ Ready	Marketplace / VSIX
IntelliJ IDEA	✅ Ready	JetBrains Marketplace
Eclipse	✅ Ready	Eclipse Marketplace

Features

• Schema Auto-completion: IntelliSense/auto-complete for apigen.json configuration files
• Real-time Validation: Validate your configuration against the APiGen schema
• Live Templates/Snippets: Quick templates for all 9 supported languages
• Direct Generation: Generate projects directly from your IDE
• Hover Documentation: Inline documentation for configuration properties

VS Code Extension

Features

• Auto-completion for apigen.json files
• Snippets: apigen-minimal, apigen-full, apigen-java, apigen-python, etc.
• Right-click menu: Generate Project, Validate Configuration
• Keyboard shortcuts configurable

IntelliJ IDEA Plugin

Features

• JSON Schema validation for apigen.json
• Live Templates: Type apigen- and press Tab
• Actions: Generate Project, Validate, New Configuration
• Settings: Preferences → Tools → APiGen

Eclipse Plugin

Features

• Content assist for apigen.json files
• Templates available via Ctrl+Space
• Context menu: APiGen → Generate Project
• Preferences: Window → Preferences → APiGen

Language Server Protocol (LSP) Server

The LSP server provides language features that can be used by any LSP-compatible editor.

Capabilities

• Text Document Sync
• Completion Provider
• Hover Provider
• Diagnostic Provider
• Code Actions
• Document Formatting