EzAdmin Low-Code Development Tool

1. Quick Start

Maven Dependencies

Choose the dependency based on your Java version:

<!-- Java 17 -->
<dependency>
    <groupId>io.github.ezadmin126</groupId>
    <artifactId>ezadmin-java17-spring-starter</artifactId>
    <version>3.0.7</version>
</dependency>

<!-- Java 8 -->
<dependency>
    <groupId>io.github.ezadmin126</groupId>
    <artifactId>ezadmin-java8-spring-starter</artifactId>
    <version>3.0.7</version>
</dependency>

Enable Configuration

Add @EnableEzadmin annotation to your Spring Boot main class:

@SpringBootApplication
@EnableEzadmin
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

application.yml Configuration

Configure EzAdmin parameters in application.yml:

topezadmin:
  # Cache switch, recommended to set false during development
  cacheFlag: false

  # Data source configuration (comma-separated for multiple)
  datasourceBeanNames: 'dataSource'

  # File upload configuration
  uploadPath: /data/upload
  downloadUrl: /core/downloadDesc.html?fileId=
  uploadUrl: /system/upload.html

  # Log configuration
  logType: 1000-10000

  # UI configuration
  adminStyle: layui
  layout: fluid

  # System routing configuration
  clearUrl: /topezadmin/clearCache.html
  signoutUrl: /login/signout.html
  indexUrl: /doc/index.html
  navUrl: /laynavs.html

  # AI feature configuration (optional)
  apiUrl: https://api.deepseek.com/v1/chat/completions
  apiKey: sk-xxxxxxxxxxxxxxxx
  model: deepseek-chat
  temperature: 0.8
 

2. Configuration Format

JSON configuration file paths:

• List configuration: topezadmin/config/layui/dsl/list/*.json
• Form configuration: topezadmin/config/layui/dsl/form/*.json

List Configuration Structure

{
  "id": "List ID",
  "name": "List Name",
  "dataSource": "Data source bean name",
  "initApi": "Custom API (optional)",
  "hideSearch": false,

  "body": {
    "emptyShow": "-",
    "showIndex": true,
    "selectable": true,
    "rowActionWidth": 175
  },

  "tabList": [],
  "search": [{"row": []},{"row": []}],
  "column": [],
  "tableButton": [],
  "rowButton": [],

  "express": {
    "main": "Query SQL expression",
    "orderBy": "order by xxx",
    "groupBy": "group by xxx",
    "count": "Custom count statement"
  }
}

Form Configuration Structure

{
  "id": "Form ID",
  "name": "Form Name",
  "dataSource": "Data source bean name",
  "successUrl": "Redirect URL after successful save",

  "cardList": [{
    "type": "card",
    "label": "Card Title",
    "fieldList": [{"row": []},{"row": []}],
    "buttonList": []
  }],

  "buttonList": [],
  "initExpress": [],
  "submitExpress": [],
  "deleteExpress": [],
  "statusExpress": []
}

3. Component Configuration

Basic Structure

{
  "item_name": "Field name (UPPERCASE)",
  "label": "Display label",
  "component": "Component type",
  "alias": "SQL alias (optional)",
  "jdbcType": "Data type (optional)",
  "operator": "Operator (optional)",

  "initData": {
    "dataJson": [{"label":"Option 1","value":"1"}],
    "dataSql": "SELECT value,label FROM table",
    "dataSource": "Data source name"
  },

  "props": {
    // Layui native properties or custom properties
  }
}

Common props Attributes

All components' props support the following common attributes:

jQuery Validate Validation Configuration

Configure more complex form validation rules via props.validate:

{
  "props": {
    "validate": {
      "rule": {
        "required": true,
        "minlength": 2,
        "maxlength": 20,
        "range": [0, 100],
        "email": true,
        "url": true,
        "number": true,
        "digits": true
      },
      "message": {
        "required": "This field cannot be empty",
        "minlength": "Enter at least 2 characters",
        "maxlength": "Enter at most 20 characters",
        "range": "Enter a number between 0-100",
        "email": "Enter a valid email address",
        "url": "Enter a valid URL",
        "number": "Enter a number",
        "digits": "Enter an integer"
      }
    }
  }
}

Common Validation Rules:

• required: Required field validation
• email: Email format
• url: URL format
• number: Number
• digits: Integer
• minlength / maxlength: Length constraints
• min / max: Value range
• range: Value range (array form)
• uploadMin / uploadMax: Upload file count limits (upload component only)

4. Routing Rules

5. Important Notes

• Field naming convention: item_name must be uppercase and match database field names
• Data format: initData supports both dataJson (static) and dataSql (dynamic) methods
• Template syntax: Supports laytpl template syntax, e.g., {{=d.field}}
• Property compatibility: props supports all Layui native properties and third-party plugin properties
• Expression engine: Based on QLExpress, supports Java syntax and SQL splicing
• Multiple data sources: Defaults to configured dataSource, can specify other data sources in initData
• Validation rules: Supports all jQuery Validate validation rules

6. AI Development Workflow