coco/relations-api

Relations API

镜像概述和主要用途

Relations API是一个内部使用的API，用于检索内容集合相关内容，具体包括CURATED关系的内容以及特定内容或内容集合（内容包）的CONTAINS关系内容。

核心功能和特性

• 检索CURATED关系类型的内容
• 检索特定内容或内容集合（内容包）的CONTAINS关系内容
• 提供应用专用和管理专用两类端点
• 支持自定义缓存时长配置，控制Get请求的缓存策略

使用场景和适用范围

适用于内部系统中需要查询内容间关系的场景，例如在内容管理平台中获取内容集合包含的子内容、内容的精选相关内容等关系数据。

使用方法和配置说明

安装

下载源代码、依赖并构建二进制文件：

shell
go get github.com/Financial-Times/relations-api
cd $GOPATH/src/github.com/Financial-Times/relations-api
go install

测试

启动Neo4J数据库：

shell
docker run --publish=7474:7474 --publish=7687:7687 -e NEO4J_AUTH=none -e NEO4J_ACCEPT_LICENSE_AGREEMENT=yes docker.xuanyuan.run/neo4j:3.4.10-enterprise

执行测试：

shell
go test -mod=readonly -race ./...

本地运行

运行二进制文件（使用帮助标志查看可用的可选参数）：

shell
$GOPATH/bin/relations-api [--help]

配置选项：

shell
  --neo-url="http://localhost:7474/db/data"   neo4j端点URL（环境变量：$NEO_URL）
  --port="8080"                               服务监听端口（环境变量：$PORT）
  --cache-duration="30s"                      Get请求的缓存时长，例如"2h45m"会将max-age值设置为"7440"秒（环境变量：$CACHE_DURATION）

端点

应用特定端点

• /content/{uuid}/relations - 获取指定内容的关系数据
• /contentcollection/{uuid}/relations - 获取指定内容集合的关系数据

管理特定端点

• /ping - 服务可用性检查
• /build-info - 构建信息查询
• /__ping - 内部可用性检查
• /__build-info - 内部构建信息查询
• /__health - 健康状态检查
• /__gtg - 服务就绪状态检查

示例

/content/{uuid}/relations端点示例

请求： GET https://pre-prod-uk-up.ft.com/__relations-api/content/9b6eb364-0275-11e7-b9ac-52b4e2bf8289/relations

响应：

json
{
    "curatedRelatedContent": [{
        "id": "http://api.ft.com/things/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90",
        "apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
    }],
    "contains": [{
        "id": "http://api.ft.com/things/74bd05b4-edca-11e6-1234-ee7d9c5b3b90",
        "apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
    }, {
        "id": "http://api.ft.com/things/74bd05b4-edca-11e6-1313-ee7d9c5b3b90",
        "apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
    }],
    "containedIn": [{
        "id": "http://api.ft.com/things/74bd05b4-adsd-1342-abbc-ee7d9c5b3b90",
        "apiUrl": "http://api.ft.com/content/74bd05b4-edca-11e6-abbc-ee7d9c5b3b90"
    }]
}

/contentcollection/{uuid}/relations端点示例（内容包）

请求： GET https://pre-prod-uk-up.ft.com/__relations-api/content/9b6eb364-0275-11e7-b9ac-52b4e2bf8289/relations

响应：

json
{
    "contains": [{
        "id": "[***]",
        "apiUrl": "[***]"
    }, {
        "id": "[***]",
        "apiUrl": "[***]"
    }],
    "containedIn": [{
        "id": "[***]",
        "apiUrl": "[***]"
    }]
}