coco/concepts-rw-neo4j

Neo4j 概念读写器（concept-rw-neo4j）

 ![Coverage Status]([]

用于向Neo4j数据库读写概念的API。

概述

concept-rw-neo4j是一个RESTful API服务，专门用于管理Neo4j图数据库中的概念数据。它提供了标准化的接口来创建、读取和更新各类概念，支持批量操作，并包含完善的监控和配置机制，适用于需要与Neo4j交互管理分类概念的后端系统。

核心功能和特性

• 提供PUT/GET接口实现概念的写入与读取
• 支持批量处理操作，可配置每批最大处理语句数
• 灵活的参数配置，支持通过命令行或环境变量设置
• 内置健康检查、就绪状态和构建信息等管理端点
• 可配置日志级别和请求日志记录功能
• 严格的数据验证，确保概念数据完整性

安装

bash
go get -u github.com/Financial-Times/concepts-rw-neo4j
cd $GOPATH/src/github.com/Financial-Times/concepts-rw-neo4j
dep ensure -v -vendor-only
go build

使用方法

本地运行

命令选项

Usage: concepts-rw-neo4j [OPTIONS]

用于在Neo4j中管理概念的RESTful API

选项:
      --app-system-code    应用程序的系统代码（环境变量 $APP_SYSTEM_CODE）（默认值 "concept-rw-neo4j"）
      --app-name           应用程序名称（环境变量 $APP_NAME）（默认值 "Concept Rw Neo4j"）
      --neo-url            neo4j端点URL（环境变量 $NEO_URL）（默认值 "http://localhost:7474/db/data"）
      --port               监听端口（环境变量 $APP_PORT）（默认值 8080）
      --batchSize          每批执行的最大语句数（环境变量 $BATCH_SIZE）（默认值 1024）
      --requestLoggingOn   是否记录请求（环境变量 $REQUEST_LOGGING_ON）（默认值 true）
      --logLevel           日志级别（环境变量 $LOG_LEVEL）（默认值 "info"）

所有参数均为可选，默认配置连接本地Neo4j实例（7474端口），应用监听8080端口，批处理大小为1024。

启动示例

bash
# 使用默认配置启动
./concepts-rw-neo4j

# 自定义配置启动
./concepts-rw-neo4j --neo-url http://neo4j:7474/db/data --port 8081 --batchSize 512

测试环境配置

测试需依赖运行中的Neo4j服务：

bash
docker run --rm -p=7474:7474 -p=7687:7687 \
    -e NEO4J_ACCEPT_LICENSE_AGREEMENT="yes" \
    -e NEO4J_AUTH="none" \
    neo4j

启动Neo4j后执行测试：

bash
go test -race ./...

服务端点

概念操作接口

PUT /{taxonomy}/{uuid}

更新或创建指定分类下的概念。

请求头：

• X-Request-Id: 请求唯一标识
• Content-Type: application/json

请求体必填字段：

• prefUUID: 概念唯一标识
• prefLabel: 首选标签
• type: 概念类型
• sourceRepresentations: 源表示数组，每个元素需包含uuid、prefLabel、type、authority和authorityValue

权限验证：仅支持"TME"、"UPP"和"Smartlogic"作为有效authority值

请求示例：

bash
curl -XPUT localhost:8080/sections/4c41f314-4548-4fb6-ac48-4618fcbfa84c \
    -H "X-Request-Id: 123" \
    -H "Content-Type: application/json" \
    -d '{
        "prefUUID": "4c41f314-4548-4fb6-ac48-4618fcbfa84c",
        "prefLabel": "Some pref label",
        "type": "Section",
        "sourceRepresentations": [{
            "uuid": "4c41f314-4548-4fb6-ac48-4618fcbfa84c",
            "prefLabel": "Some pref label",
            "type": "Section",
            "authority": "TME",
            "authorityValue": "1234578fdh"
        }]
    }'

成功响应（200 OK）：

json
{
    "events": [
        {
            "conceptType": "Section",
            "conceptUUID": "4c41f314-4548-4fb6-ac48-4618fcbfa84c",
            "eventDetails": {
                "type": "Concept Updated"
            }
        }
    ],
    "updatedIds": [
        "4c41f314-4548-4fb6-ac48-4618fcbfa84c"
    ]
}

GET /{taxonomy}/{uuid}

读取指定分类下的概念。

请求头：

• X-Request-Id: 请求唯一标识

响应：

• 200 OK: 返回概念详情（空字段将被省略）
• 404 Not Found: 概念不存在

请求示例：

bash
curl -H "X-Request-Id: 123" localhost:8080/sections/3fa70485-3a57-3b9b-9449-774b001cd965

管理端点

• 健康检查：http://localhost:8080/__health
• 就绪检查：http://localhost:8080/__gtg
• 构建信息：http://localhost:8080/build-info

配置参数

部署

通过常规流程部署到交付集群，详见：部署流程

日志

应用使用logrus日志框架，日志配置通过运行参数控制：

• logLevel: 设置日志详细程度，debug级别提供最详细日志
• requestLoggingOn: 布尔值，控制是否记录HTTP请求详情