coco/people-rw-neo4j

People Reader/Writer for Neo4j (people-rw-neo4j) [已退役]

镜像概述

这是一个用于向Neo4j数据库读写人员数据的API，要求传入的人员JSON数据格式与人员转换器输出的格式一致，支持对人员信息的创建、更新、查询和删除操作。

核心功能

• 提供PUT/GET/DELETE端点处理人员数据的增删改查
• 支持批量处理查询，可配置批量大小
• 包含健康检查（/__health）和Ping（/ping、/__ping）等管理端点
• 集成logrus日志系统，支持本地控制台输出和非本地文件记录
• 可选对接Graphite进行指标收集

使用场景

适用于需要将人员信息存储到Neo4j图数据库的场景，例如企业内部人员数据管理系统、内容平台的作者信息管理等。

配置说明

运行镜像时可通过命令行参数配置以下选项（均为可选，有默认值）：

• --neo-url：Neo4j数据库地址，默认本地7474端口
• --port：应用运行端口，默认8080
• --batchSize：批量处理大小，默认1024
• --graphiteTCPAddress：Graphite服务地址，默认空（不发送指标）
• --graphitePrefix：指标前缀，默认空
• --logMetrics：是否记录指标，默认false

部署示例

Docker Run命令

bash
docker run -d -p 8080:8080 docker.xuanyuan.run/coco/people-rw-neo4j \
  --neo-url=neo4j://your-neo4j-host:7474 \
  --port=8080 \
  --batchSize=50 \
  --logMetrics=true

端点说明

PUT /people/{uuid}

• 必须字段：路径与请求体中的uuid需一致，alternativeIdentifier中的uuids
• 操作逻辑：MERGE（存在则更新，不存在则创建）
• 响应：成功返回200；无效输入（JSON错误、uuid不匹配）返回400；批量失败返回500

示例请求：

bash
curl -XPUT localhost:8080/people/3fa70485-3a57-3b9b-9449-774b001cd965 \
  -H "X-Request-Id:123" \
  -H "Content-Type:application/json" \
  -d '{"uuid":"3fa70485-3a57-3b9b-9449-774b001cd965","birthYear":1974,"salutation":"Mr","name":"Robert W. Addington","prefLabel":"Robert Addington","twitterHandle":"@rwa","facebookProfile":"raddington","linkedinProfile":"robert-addington","description":"Some text","descriptionXML":"Some text containing <strong>markup</strong>","_imageUrl":"http://someimage.jpg","alternativeIdentifiers":{"TME":["MTE3-U3ViamVjdHM="],"uuids":["3fa70485-3a57-3b9b-9449-774b001cd965","6a2a0170-6afa-4bcc-b427-430268d2ac50"],"factsetIdentifier":"000BJG-E"},"type":"People"}'

GET /people/{uuid}

• 查询指定uuid的人员信息（内部接口，非公开API）
• 响应：存在返回200（空字段会被省略）；不存在返回404

示例请求：

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

DELETE /people/{uuid}

• 删除指定uuid的人员信息
• 响应：成功返回204；不存在返回404

示例请求：

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

管理端点

• 健康检查：http://localhost:8080/__health
• Ping：http://localhost:8080/ping 或 http://localhost:8080/__ping

日志说明

• 非本地环境日志写入文件；本地环境日志输出到控制台（需本地写入文件时，传入非local的env参数）
• /build-info端点调用不记录日志（避免频繁请求淹没日志）