coco/public-concordances-api

public-concordances-api 镜像文档

概述

public-concordances-api是一个Go应用程序，提供公共API用于检索存储在Neo4j图数据库中的Concordances数据。该应用直接依赖于与Neo4j数据库的连接，通过API端点返回符合查询条件的标识符信息。

核心功能与特性

• 提供公共API接口，支持通过概念ID或权威标识符查询Concordances数据
• 支持多概念ID或多标识符值的批量查询
• 内置健康检查、构建信息和就绪检查等Admin端点
• 可配置Neo4j数据库连接URL和服务监听端口，支持默认参数

使用场景

适用于需要访问Concordances数据的服务或应用，例如：

• 通过概念ID获取关联的所有标识符信息
• 通过权威标识符和值查询对应的API URL
• 批量获取多个概念的标识符数据

使用方法

本地安装与运行

安装前提：已安装go和dep并添加到系统PATH。

1. 获取源码：

   bash
   go get -u github.com/Financial-Times/public-concordances-api
   

2. 进入项目目录：

   bash
   cd $GOPATH/src/github.com/Financial-Times/public-concordances-api
   

3. 安装依赖：

   bash
   dep ensure
   

4. 构建并运行：

   bash
   go install
   $GOPATH/bin/public-concordances-api --neo-url={neo4jUrl} --port={port}
   

Docker部署示例

运行应用容器：

bash
docker run --rm -p 8080:8080 public-concordances-api --neo-url=http://neo4j:7474/db/data --port=8080

运行Neo4j数据库容器（用于测试或开发环境）：

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

配置参数

API端点

支持以下GET请求：

• GET /concordances?conceptId={thingUri}
  返回给定概念的所有标识符列表

• GET /concordances?conceptId={thingUri}&conceptId={thingUri}...
  返回每个提供的概念的所有标识符列表

• GET /concordances?authority={identifierUri}&identifierValue={identifierValue}
  返回匹配对应标识符的apiUrl

• GET /concordances?authority={identifierUri}&identifierValue={identifierValue}&identifierValue={identifierValue}...
  返回对应标识符的所有apiUrl列表

Admin端点

• GET /__health：健康检查端点
• GET /__build-info：构建信息端点
• GET /__gtg：就绪检查端点

错误处理

服务遵循以下错误处理规则：

• 至少需要提供1个conceptId参数或1组authority + identifierValue参数对，否则返回错误HTTP状态码
• 若同时提供conceptId和authority参数，返回错误HTTP状态码
• 若仅提供identifierValue而未提供authority参数，返回错误HTTP状态码
• 若查询的conceptId或identifierValue在Concordances中不存在，返回空数组而非错误状态码

更多错误处理详情参见：Run book、Panic guide

测试

1. 启动Neo4j测试容器：

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

2. 执行测试：

   bash
   go test -race ./...