magic-api Documentation

To use magic-api in a Spring Boot application, include the magic-api-spring-boot-starter dependency in your pom.xml file.

<!-- 以spring-boot-starter的方式引用 -->
<dependency>
	<groupId>org.ssssssss</groupId>
    <artifactId>magic-api-spring-boot-starter</artifactId>
    <version>2.2.2</version>
</dependency>

For versions 0.7.x and later, magic-api requires two specific tables to manage files and backup records. You must execute the following SQL statements to set up the schema in your database.

-- File storage table
CREATE TABLE `magic_api_file_v2` (
  `file_path` varchar(512) NOT NULL,
  `file_content` mediumtext,
  PRIMARY KEY (`file_path`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

-- Backup record table
CREATE TABLE `magic_backup_record_v2` (
  `id` varchar(32) NOT NULL COMMENT '原对象ID',
  `create_date` bigint(13) NOT NULL COMMENT '备份时间',
  `tag` varchar(32) DEFAULT NULL COMMENT '标签',
  `type` varchar(32) DEFAULT NULL COMMENT '类型',
  `name` varchar(64) DEFAULT NULL COMMENT '原名称',
  `content` blob COMMENT '备份内容',
  `create_by` varchar(64) DEFAULT NULL COMMENT '操作人',
  PRIMARY KEY (`id`,`create_date`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

To use Nebula graph capabilities within magic-api, add the magic-api-plugin-nebula dependency to your Maven pom.xml file. Replace magic-api-lastest-version with the actual latest version of magic-api.

<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-api-plugin-nebula</artifactId>
    <version>magic-api-lastest-version</version>
</dependency>

Configure the connection details for your Nebula graph instance in your application's YAML configuration file using the nebula prefix. You can use environment variables for sensitive information.

Available keys:

• hostAddress: The host and port of the Nebula server (defaults to localhost:9669).
• userName: The username for authentication (defaults to root).
• password: The password for authentication (defaults to nebula).

nebula:
  hostAddress: ${NEBULA_HOSTADDRESS:localhost:9669}
  userName: ${NEBULA_USERNAME:root}
  password: ${NEBULA_PASSWORD:nebula}

After adding the dependency, configure the following properties in your application.properties file:

• magic-api.web: Defines the URL path for the web-based management interface.
• magic-api.resource.location: Defines where the configuration files are stored. Note: If the path starts with classpath:, the mode is read-only.

server.port=9999
#配置web页面入口
magic-api.web=/magic/web
#配置文件存储位置。当以classpath开头时，为只读模式
magic-api.resource.location=/data/magic-api

You can interact with Nebula using the nebula module imported in your magic-api scripts.

Key methods:

• nebula.executeJson(ngsl): Executes a Nebula Graph Language (NGSL) query and returns the result as a JSON object. Use nebula.convert(resultJson) to format the output.
• nebula.executeNebulaModel(ngsl): Executes a query specifically designed to return a graph model structure.

For a full list of available methods, refer to the source class org.ssssssss.magicapi.nebula.NebulaModule.

import nebula;
var ngsl = 
    """
        USE db_name;MATCH p_=(p:`assignee`)-[*3]-(p2:`transferor`) where  id(p2) == "阿里巴巴"  or id(p)== "阿里巴巴" RETURN p_ limit 1000'
    """
var resultJson = nebula.executeJson(ngsl)
nebula.convert(resultJson)

nebula.executeNebulaModel(ngsl)