Editor/Editor Intro

Editor

ApiHug IDEA Plugin Handbook

Task-oriented guidance for the ApiHug API Design Copilot plugin.

What This Section Covers

This section explains how to use the ApiHug IntelliJ plugin to create projects, edit proto contracts, inspect generated metadata, and run everyday design tasks without leaving the IDE.

Recommended Path

If you are new to the plugin, read these pages in order:

  1. Install ApiHug API Design Copilot
  2. Start Project
  3. Tool Window
  4. Service Design and Debug Panel
  5. Editor Assistant

Key Tasks

TaskPage
Learn shortcutsShortcut Cheatsheet
Solve common setup issuesFAQ
Create a new projectStart Project
Inspect API detailsAPI Details
Design constants, errors, and entitiesConstants, Errors, Entity
Run stub and test flowsStub, API Test
Configure local toolingServer Settings, Export Settings, Knowledge Settings

Result

After working through this section, you should be able to use the plugin as the primary editing surface for ApiHug contract design instead of treating it as a passive viewer.

Copyright © 2026 ApiHug·AI-native Enterprise Architecture Factory