RESTful API

本文介绍嬴图RESTful API客户端工具的使用规范。

准备工作

• 一个命令行工具：
  • Linux或MacOS：Bash, Zsh, TCSH
  • Windows：PowerShell
• 与操作系统相适配的嬴图 RESTful API

启动API服务

1. 显示帮助信息

./ultipa_restful_api.exe --help

2. 显示工具版本号

./ultipa_restful_api.exe --version

3. 启动API服务

./ultipa_restful_api.exe -hosts 192.168.1.85:61095,192.168.1.87:61095,192.168.1.88:61095 -u employee -p joaGsdf -w 3

注：-hosts、-u、-p等效于--hosts、--username、--password。

其他参数：

API基本信息

• 请求类型：POST
• 请求网段：
  • Linux：API服务所连接的嬴图服务器地址，如http://192.168.1.88
  • Windows/MacOS：API服务本机地址，即http://127.0.0.1
• 请求端口：启动API服务时通过-w、-l设置的有效端口
• Body参数类型：JSON、FORM

登录嬴图服务器

• 请求地址

.../login

• 请求示例

{
    "username": "employee",
    "password": "joaGsdf"
}

• 响应结果：登录后的token值

其余API接口均须使用Headers中的Cookie携带token值ultipa=<token_value>，Content_Type为application/json。

发送UQL

• 请求地址

.../uql

• 请求参数

• 请求示例

{
    "uql": "find().nodes({name == \"abc\"}) return count(nodes)",
    "graph": "test_text"
}

• 成功响应示例

{
    "Data": [
        {
            "Name": "count(nodes)",
            "PropertyType": 4,
            "Rows": [
                2
            ]
        }
    ],
    "Graph": "test_text",
    "Statistic": {
        "NodeAffected": 0,
        "EdgeAffected": 0,
        "TotalCost": 0,
        "EngineCost": 0
    },
    "Status": {
        "Message": "",
        "Code": 0
    }
}

发送UQL并限制流式返回结果

• 请求地址

.../uql/stream

• 请求参数

• 请求示例

{
    "uql": "find().nodes({name == \"abc\"}) return nodes",
    "graph": "test_text",
    "package_num": 1
}

• 成功响应示例

插入点

• 请求地址

.../insert/nodes

• 请求参数

• 请求示例

{
    "nodes": [{"name":"Jason","_id":"USER001"},{"name":"Alice"}],
    "schema": "default",
    "graph": "test_text",
    "sync": true
}

• 成功响应示例

{
    "Msg": "Insert Nodes Success: [{\"_id\":\"USER001\",\"name\":\"Jason\"},{\"name\":\"Alice\"}]"
}

插入边

• 请求地址

.../insert/edges

• 请求参数

• 请求示例

{
    "edges": [{"year":"1998", "_from":"USER001", "_to":"USER002"}],
    "schema": "default",
    "graph": "test_text",
    "sync": true
}

• 成功响应示例

{
    "Msg": "Insert Edges Success: [{\"_from\":\"USER001\",\"_to\":\"USER002\",\"year\":\"1998\"}]"
}

更新点

根据_id或_uuid对点进行更新。

• 请求地址

.../update/nodes

• 请求参数

• 请求示例

{
    "nodes": [{"age":"35", "_id":"USER001"}, {"name":"John", "_id": "USER002"}],
    "graph": "test_text"
}

• 成功响应示例

{
    "Msg": "Update nodes on test_text",
    "SuccessCount": 2
}

更新边

根据_from和_to、或_uuid对边进行更新。

• 请求地址

.../update/edges

• 请求参数

• 请求示例

{
    "edges": [{"_uuid":"1","_from_uuid":"2", "age":"55"}],
    "graph": "test_text"
}

• 成功响应示例

{
    "Msg": "Update edges on test_text",
    "SuccessCount": 1
}