Introduction

ApiGear Studio is a desktop application for designing APIs, generating SDKs, and monitoring API traffic — all in one integrated environment. It provides a visual interface for the complete API-first development workflow.

Key Features

API Design

Create and manage ObjectAPI module files that define your interfaces, data structures, and enums. The built-in validation ensures your API definitions are correct before code generation.

Code Generation

Configure SDK generation with solution files that link your API modules to technology templates. Run generation with a single click or enable auto-run to regenerate whenever files change.

Scripted Backends

Test your client code against simulated services. Create scenario files with JavaScript that define how your mock service behaves, then run them directly from Studio.

Real-Time Monitoring

Connect your applications to Studio's monitoring endpoint and watch API calls flow through in real-time. Debug integration issues and verify correct API usage.

Template Management

Browse, install, and manage SDK templates from the ApiGear registry. Templates are cached locally and automatically versioned.

Platform Support

ApiGear Studio is available for:

• macOS — Intel and Apple Silicon
• Windows — 64-bit
• Linux — 64-bit (AppImage)

Installation

Download the latest release from the GitHub releases page.

macOS

1. Download the .dmg file
2. Open the disk image
3. Drag ApiGear Studio to your Applications folder
4. On first launch, right-click and select "Open" to bypass Gatekeeper

Windows

1. Download the .exe installer
2. Run the installer
3. Follow the installation wizard
4. Launch from the Start menu

Linux

1. Download the .AppImage file
2. Make it executable: chmod +x ApiGear-Studio-*.AppImage
3. Run the AppImage

Auto-Updates

Studio automatically checks for updates when launched. When a new version is available:

1. A notification prompts you to update
2. The update downloads in the background
3. Restart the application to apply the update

Update Channels

In Settings, you can choose between stable (recommended) and beta update channels. Beta releases include newer features but may be less stable.

Configuration

Studio stores its configuration and template cache in platform-specific locations:

Platform	Configuration Path
macOS	~/Library/Application Support/ApiGear Studio/
Windows	%APPDATA%\ApiGear Studio\
Linux	~/.config/ApiGear Studio/

Server Ports

Studio runs local servers for simulation and monitoring:

• Default Port: 4333
• Monitor Endpoint: http://localhost:4333/monitor/{source}
• Simulation Endpoint: ws://localhost:4333/ws

You can change the port in Settings → Connection if the default conflicts with other services.

Editor Integration

Studio opens API files in your preferred code editor. Configure the editor command in Settings → Application:

Editor	Command
VS Code	code
VS Code Insiders	code-insiders
Sublime Text	subl
Vim	vim
Custom	Any executable in your PATH

Getting Help

• Documentation — Click the Help button in the header or visit apigear.io/docs
• Issues — Report bugs at github.com/apigear-io/studio/issues
• Community — Join the discussion on Slack