coco/public-content-by-concept-api

内容按概念公共API（public-content-by-concept-api）

https://circleci.com/gh/Financial-Times/public-content-by-concept-api.svg?style=shield](https://circleci.com/gh/Financial-Times/public-content-by-concept-api) https://goreportcard.com/badge/github.com/Financial-Times/public-content-by-concept-api](https://goreportcard.com/report/github.com/Financial-Times/public-content-by-concept-api) https://coveralls.io/repos/github/Financial-Times/public-content-by-concept-api/badge.svg](https://coveralls.io/github/Financial-Times/public-content-by-concept-api)

一个公共API，返回关于指定概念的最新注释内容的有序列表

镜像概述

该镜像提供一个公共API服务，基于Neo4J数据库，用于检索与特定概念相关的最新注释内容。用户可通过API请求获取按时间排序的内容列表，并支持通过参数筛选结果范围。

核心功能与特性

• 基于Neo4J数据库：依赖Neo4J图数据库存储和查询内容数据
• 灵活的参数配置：支持自定义数据库连接URL、服务端口、缓存时长、日志级别等
• 结果筛选：支持通过日期范围（fromDate、toDate）、数量限制（limit）、分页（page）等参数筛选内容
• 缓存机制：可配置缓存时长，优化重复请求性能
• 日志控制：支持设置日志级别（DEBUG/INFO/WARN/ERROR）及请求日志开关

使用场景

适用于需要获取特定概念相关内容的应用场景，如：

• 内容聚合平台展示特定主题的最新内容
• 信息检索系统获取按概念分类的注释内容
• 数据分析工具收集特定领域的相关资料

使用方法

本地安装与运行

1. 获取源码：

   bash
   go get -u github.com/Financial-Times/public-content-by-concept-api
   

2. 进入项目目录：

   bash
   cd $GOPATH/src/github.com/Financial-Times/public-content-by-concept-api
   

3. 安装并运行：

   bash
   go install
   $GOPATH/bin/public-content-by-concept-api --neo-url={neo4jUrl} --port={port} --log-level={DEBUG|INFO|WARN|ERROR} --cache-duration={例如22h10m3s} --requestLoggingEnabled=false
   

参数说明

测试

单元测试

bash
go test -race ./...

单元与集成测试

bash
docker-compose -f docker-compose-tests.yml up -d --build && \
docker logs -f test-runner && \
docker-compose -f docker-compose-tests.yml down

请求示例

1. 基础请求（按概念URI获取内容）：

   bash
   curl http://localhost:8080/content?isAnnotatedBy=http://api.ft.com/things/dbb0bdae-1f0c-11e4-b0cb-b2227cce2b54
   

2. 带日期和数量筛选：

   bash
   curl http://localhost:8080/content?isAnnotatedBy=http://api.ft.com/things/dbb0bdae-1f0c-11e4-b0cb-b2227cce2b54&fromDate=2016-01-02&toDate=2016-01-05&limit=200
   

3. 分页请求：

   bash
   curl http://localhost:8080/content?isAnnotatedBy=http://api.ft.com/things/dbb0bdae-1f0c-11e4-b0cb-b2227cce2b54&fromDate=2016-01-02&toDate=2016-01-05&page=3&limit=200
   

注意：isAnnotatedBy参数支持完整概念URI或仅UUID。

管理端点

• 健康检查：http://localhost:8080/__health
• 服务可用性检查：http://localhost:8080/__gtg
• 构建信息：http://localhost:8080/__build-info

API定义

详细API规范参考https://docs.google.com/a/ft.com/document/d/1YjqNYEXkc0Ip-6bGttwnPcAh2XKG6tgzmojTdq8gM2s%EF%BC%88%E9%9C%80FT%E5%86%85%E9%83%A8%E8%AE%BF%E9%97%AE%E6%9D%83%E9%99%90%EF%BC%89