Skip to content

Settings ​

EasyApi provides flexible configuration through IDE settings, local rule files, and remote config files.

Configuration Methods ​

MethodScopeDescription
IDE SettingsGlobal / ProjectConfigure in IntelliJ preferences, including the Rules tab and AI tab
Local Config FileProject / Global.easyapi/*.rules folder model (recommended) or legacy .easy.api.config
Remote Config FileProjectLoad config from a remote URL

Config Rules ​

Rules are the core of EasyApi's extensibility. They allow you to customize how APIs are parsed, documented, and exported. EasyApi understands standard HTTP frameworks out of the box — most projects need no custom rules.

  • Config Rules — Rule syntax, filter prefixes, and ways to write rules (built-in AI Assistant or external skill)
  • Callbacks & Events — Parse and export event hooks
  • Script Tools — Built-in tools for Groovy scripts

Advanced ​

Features and channel settings ​

Use IDE Settings > Features to control framework recognizers, export channels, and field-format channels. Experimental Hoppscotch, OpenAPI, and ApiPost channels are disabled by default. Most of these extension points can be turned off when they are not relevant to a project; the Features tab also controls API scanning (with automatic and concurrent options) and editor integration, all of which take effect immediately without an IDE restart. Their channel-specific settings are available from the EasyApi settings tree.

Released under the Apache-2.0 License.