Configuration

EasyYapi provides a flexible configuration system to customize API documentation generation behavior.

Configuration Methods

Local Config File

Create a .easy.api.config file in your project root or module root directory:

properties

# Ignore specific fields
field.ignore=groovy:it.hasAnn("com.fasterxml.jackson.annotation.JsonIgnore")

# Type conversion
json.rule.convert=groovy:it.type().name()=="java.util.Date" => java.lang.String

See Local Config File.

Remote Config File

Configure a remote URL to fetch configuration:

properties

remote.url=http://your-config-server.com/easy-api.config

See Remote Config File.

IDE Settings

Configure EasyYapi global settings in the IDE.

See IDE Settings.

Configuration Content

Category	Description
Config Rules	Rules for customizing API documentation generation
Callbacks & Events	Execute custom logic at specific events
Script Tools	Tools available in Groovy scripts
Advanced	Advanced custom configuration

Configuration Priority

Remote config (highest priority)
Module root config
Project root config
IDE settings (lowest priority)

Configuration ​

Configuration Methods ​

Local Config File ​

Remote Config File ​

IDE Settings ​

Configuration Content ​

Configuration Priority ​