coco/internal-content-api

Internal Content API (internal-content-api)

镜像概述和主要用途

Internal Content API用于提供已发布内容，包含内部组件和富内容字段的聚合结果，通过整合富内容源与内部组件源的信息，为客户端提供完整的内部内容访问服务。

核心功能和特性

• 内容聚合：整合富内容（enriched content）与内部组件（internal components），返回完整的内部内容
• 灵活配置：支持通过参数配置服务端口、处理路径、数据源URI等关键信息
• 内容展开：提供unrollContent参数，支持动态内容、图片等资源的展开功能
• 健康监控：内置健康检查（/__health）、就绪检查（/__gtg）等管理端点，监控服务及依赖服务状态
• 多数据源支持：可配置富内容源、内部组件源、内容展开器等多个依赖服务

使用场景和适用范围

适用于需要访问包含内部组件的已发布内容的服务场景，如内容管理系统、内部内容预览平台、内容分析工具等，尤其适合需要整合富内容与内部组件数据的业务系统。

详细使用方法和配置说明

拉取镜像

bash
# 假设镜像名称为internal-content-api，具体请替换为实际镜像仓库地址
docker pull docker.xuanyuan.run/internal-content-api:latest

运行容器

基本运行命令

bash
docker run -d \
  -p 8084:8084 \
  --name internal-content-api \
  docker.xuanyuan.run/internal-content-api:latest \
  --app-port "8084" \
  --handler-path "internalcontent" \
  --content-source-uri "http://content-source:8080/__enriched-content-read-api/enrichedcontent" \
  --internal-components-source-uri "http://internal-components-source:8080/__content-public-read/internalcontent" \
  --content-source-app-name "Content Source Service" \
  --internal-components-source-app-name "Internal Components Source Service" \
  --content-source-app-health-uri "http://content-source:8080/__enriched-content-read-api/__health" \
  --internal-components-source-app-health-uri "http://internal-components-source:8080/__content-public-read/__health" \
  --content-unroller-app-name "Content Unroller" \
  --content-unroller-uri "http://content-unroller:8080/__content-unroller-api/internalcontent" \
  --content-unroller-app-health-uri "http://content-unroller:8080/__content-unroller-api/__health"

配置参数说明

本地开发运行

前提条件

• Go 1.13+
• dep（依赖管理工具）

安装与构建

bash
# 获取源码
go get -u github.com/Financial-Times/internal-content-api
cd $GOPATH/src/github.com/Financial-Times/internal-content-api

# 安装依赖
dep ensure

# 运行测试并构建
go test -race ./...
go build .

启动服务

bash
# 安装二进制
go install

# 启动服务（参数为示例，需根据实际环境调整）
$GOPATH/bin/internal-content-api \
  --app-port "8084" \
  --handler-path "internalcontent" \
  --content-source-uri "http://localhost:8080/__enriched-content-read-api/enrichedcontent" \
  --internal-components-source-uri "http://localhost:8080/__content-public-read/internalcontent" \
  --content-source-app-health-uri "http://localhost:8080/__enriched-content-read-api/__health" \
  --internal-components-source-app-health-uri "http://localhost:8080/__content-public-read/__health" \
  --content-unroller-uri "http://localhost:8080/__content-unroller-api/internalcontent" \
  --content-unroller-app-health-uri "http://localhost:8080/__content-unroller-api/__health"

端点说明

GET /{handler-path}/{uuid}

获取指定UUID的内部内容（富内容与内部组件的聚合结果）。

请求示例

bash
curl -v http://localhost:8084/internalcontent/9358ba1e-c07f-11e5-846f-79b0e3d20eaf

可选参数

• unrollContent={boolean}：是否展开动态内容、主图、正文图片、导语图片和备选图片，默认false
  当设为true时，将通过内容展开器服务获取并展开相关资源内容；设为false时，仅返回资源ID。

响应码说明

• 200：成功返回内容
• 404：指定UUID的内容不存在
• 503：依赖的服务（如富内容源、内部组件源）不可用

管理端点

路径自定义说明

当handler-path配置为非默认值（如internalcontent-preview）时，内容访问端点将自动调整为/{handler-path}/{uuid}，例如：
http://localhost:8084/internalcontent-preview/9358ba1e-c07f-11e5-846f-79b0e3d20eaf