coco/document-store-api

自动构建

coco

Document Store API是一个基于Dropwizard的应用，提供对MongoDB的读写功能，支持内容和列表的CRUD操作，包含直接读取（/content）和格式化读取（/content-read）两种端点，适用于文档存储与检索场景。

下载次数: 0状态：自动构建维护者：coco仓库类型：镜像最近更新：1 年前

使用轩辕镜像，把时间还给真正重要的事。点击查看

中文简介版本下载

使用轩辕镜像，把时间还给真正重要的事。点击查看

Document Store API

镜像概述与主要用途

Document Store API是一个基于Dropwizard的应用程序，用于对MongoDB进行读写操作。该应用提供两种内容读取端点：/content-read/{uuid}用于按API设计契约返回格式化内容，确保响应格式符合规范；/content/{uuid}用于直接读取MongoDB中的原始文档，无格式限制。此外，应用还支持独立的列表（list）操作，其读写逻辑与内容操作分离。

核心功能与特性

内容操作：支持内容的创建（PUT）、读取（GET）、删除（DELETE），包括单条内容操作和批量获取
内容检索：提供通过UUID直接读取、批量UUID查询、标识符（authority和identifierValue）查询等多种检索方式
列表操作：支持列表的创建（PUT）、读取（GET）、删除（DELETE），以及按概念（concept）和类型（listType）查询列表
健康检查：包含MongoDB连接状态和索引状态检查，连接状态影响GTG（Good To Go）响应
日志管理：使用slf4j-json-logger库，日志格式固定为%m%n以适配监控工具

使用场景与适用范围

适用于需要高效文档存储与检索的后端服务，如内容管理系统、新闻资讯平台等场景，支持结构化文档和列表数据的管理需求。

使用方法与配置说明

本地运行

编译构建JAR包

sh
# 跳过测试编译
mvn clean package -Djava.net.preferIPv4Stack=true -Dmaven.test.skip=true

# 仅运行非集成测试
mvn clean package -Djava.net.preferIPv4Stack=true -Dshort

# 运行所有测试（需本地MongoDB）
docker-compose up mongodb -d
MONGO_TEST_URL=localhost:27017 -Djava.net.preferIPv4Stack=true mvn clean package

启动应用

sh
java -jar target/document-store-api-0.0.1-SNAPSHOT.jar server config-local.yml

构建与部署

Docker镜像构建

需传递Nexus服务器认证参数：

sh
docker build -t coco/document-store-api --build-arg SONATYPE_USER=upp-nexus --build-arg SONATYPE_PASSWORD=AvailableInLastPass .

注意：自2016-10-18起，不再部署至UCS环境。

API操作说明

内容操作（Content）

创建/更新内容（PUT）

请求URL：http://localhost:14180/content/{uuid}
请求头：Content-Type: application/json
请求体示例：

json
{
    "uuid": "3b7b7702-debf-11e4-b9ec-00144feab7de",
    "title": "Ukraine looks to foreign-born ministers to kick-start reform",
    "titles": null,
    "byline": "Roman Olearchyk, Kiev, and Neil Buckley, London",
    "brands": [
        {
            "id": "http://api.ft.com/things/dbb0bdae-1f0c-11e4-b0cb-b2227cce2b54"
        }
    ],
    "identifiers": [
        {
            "authority": "http://api.ft.com/system/FTCOM-METHODE",
            "identifierValue": "3b7b7702-debf-11e4-b9ec-00144feab7de"
        }
    ],
    "publishedDate": "2015-04-15T08:33:02.000Z",
    "body": "<body><content data-embedded=\"true\" id=\"937885ac-e2bc-11e4-347b-978e959e1c97\" type=\"http://www.ft.com/ontology/content/ImageSet\"></content><p>Late last year, US-born Natalie Jaresko was in the Kiev office of the investment firm she founded in 2006 when headhunters came to call. Within days she was named as finance minister of war-torn country.</p></body>",
    "description": null,
    "mediaType": null,
    "pixelWidth": null,
    "pixelHeight": null,
    "internalBinaryUrl": null,
    "members": null,
    "mainImage": "937885ac-e2bc-11e4-347b-978e959e1c97"
}

说明：不支持的字段将被忽略，请求体格式与内容转换器的GET响应一致。

删除内容（DELETE）

请求URL：http://localhost:14180/content/{uuid}
请求头：Content-Type: application/json

获取内容（GET）

单条获取：GET http://localhost:14180/content/{uuid}，返回与PUT请求体格式一致的JSON

批量获取（推荐）：POST /{collection}?mget=true，请求体为UUID数组，返回找到的内容数组（未找到则返回空数组）

json
[
  "fd204ed1-d53d-4b24-99a7-fc62a6778808",
  "4f97b689-d3e4-4ae2-ac34-9abc97a46c28",
  "c86ccb61-38d2-42bd-bb2f-9c69e1fca178"
]

批量获取（已弃用）：GET http://localhost:14180/content?uuid={uuid1}&uuid={uuid2}...，受URI长度限制（2083字符）

按标识符查询内容

请求URL：GET http://localhost:14180/content-query?identifierAuthority={authority}&identifierValue={identifierValue}
响应码：
- 301：找到单条文档，Location头包含文档URI
- 404：未找到匹配文档
- 500：找到多条文档（非预期情况）
示例请求：GET /content-query?identifierAuthority=http://api.ft.com/system/FT-LABS-WP-1-335&identifierValue=http://www.ft.com/fastft/2015/12/09/south-african-rand-dives-after-finance-ministers-exit/ HTTP/1.1

列表操作（List）

创建/更新列表（PUT）

请求URL：http://localhost:14180/lists/{uuid}
请求头：Content-Type: application/json
请求体示例：

json
{
    "uuid": "3c99c2ba-a6ae-11e2-95b1-00144feabdc0",
    "title": "Test List",
    "concept": {
        "uuid": "78d878ac-6226-47e4-84b1-39a127e3cc11",
        "prefLabel": "Markets"
    },
    "listType": "TopStories",
    "items" : [
        {
            "uuid": "0237b884-d124-11e2-be7b-00144feab7de"
        },
        {
            "uuid": "68340f9f-67c3-33cd-97b1-f07bea7ce714"
        },
        {
            "webUrl": "http://video.ft.com/3887333300001/Thames-tour-shows-changing-London-skyline/life-and-arts"
        }
    ]
}

说明：concept和listType为可选字段；若提供concept，则uuid和prefLabel为必填；数据存储中不允许存在相同concept和listType的多个列表，重复时将触发Splunk告警。

获取列表（GET）

单条获取：GET http://localhost:14180/lists/{uuid}
按概念和类型获取：GET http://localhost:14180/lists?curatedTopStoriesFor={concept-uuid}（支持多种列表类型，如curatedOpinionAndAnalysisFor），返回单条结果（多条匹配时返回一条并记录错误日志）

删除列表（DELETE）

请求URL：http://localhost:14180/lists/{uuid}
请求头：Content-Type: application/json

扩展配置：添加新资源类型

如需添加新资源类型，需在DocumentStoreApiApplication中为所需操作添加新的链处理器，处理器（Handler）和目标（Targets）可在多链中复用。

健康检查与GTG

健康检查项：MongoDB连接状态、MongoDB集合索引状态
GTG响应：仅受MongoDB连接状态影响，连接状态变化时应用状态按以下状态图切换：
!状态图

日志配置

使用slf4j-json-logger库，日志格式固定为%m%n（详见https://github.com/savoirtech/slf4j-json-logger#logging-configuration%EF%BC%89%EF%BC%8C%E4%BB%A5%E9%80%82%E9%85%8DSplunk%E7%AD%89%E7%9B%91%E6%8E%A7%E5%B7%A5%E5%85%B7%E7%9A%84%E4%BA%8B%E4%BB%B6%E6%9F%A5%E8%AF%A2%E3%80%82

查看更多 document-store-api 相关镜像 →

轩辕镜像配置手册

探索更多轩辕镜像的使用方法，找到最适合您系统的配置方式

Docker 配置

登录仓库拉取

通过 Docker 登录认证访问私有仓库

专属域名拉取

无需登录使用专属域名

K8s Containerd

Kubernetes 集群配置 Containerd

K3s

K3s 轻量级 Kubernetes 镜像加速

Dev Containers

VS Code Dev Containers 配置

Podman

Podman 容器引擎配置

Singularity/Apptainer

HPC 科学计算容器配置

其他仓库配置

ghcr、Quay、nvcr 等镜像仓库

Harbor 镜像源配置

Harbor Proxy Repository 对接专属域名

Portainer 镜像源配置

Portainer Registries 加速拉取

Nexus 镜像源配置

Nexus3 Docker Proxy 内网缓存

系统配置

Linux

在 Linux 系统配置镜像服务

Windows/Mac

在 Docker Desktop 配置镜像

MacOS OrbStack

MacOS OrbStack 容器配置

Docker Compose

Docker Compose 项目配置

NAS 设备

群晖

Synology 群晖 NAS 配置

飞牛

飞牛 fnOS 系统配置镜像

绿联

绿联 NAS 系统配置镜像

威联通

QNAP 威联通 NAS 配置

极空间

极空间 NAS 系统配置服务

网络设备

爱快路由

爱快 iKuai 路由系统配置

宝塔面板

在宝塔面板一键配置镜像

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

使用与功能问题

配置了专属域名后，docker search 为什么会报错？

docker search 限制

Docker Hub 上有的镜像，为什么在轩辕镜像网站搜不到？

站内搜不到镜像

机器不能直连外网时，怎么用 docker save / load 迁镜像？

离线 save/load

docker pull 拉插件报错（plugin v1+json）怎么办？

插件要用 plugin install

WSL 里 Docker 拉镜像特别慢，怎么排查和优化？

WSL 拉取慢

轩辕镜像安全吗？如何用 digest 校验镜像没被篡改？

安全与 digest

第一次用轩辕镜像拉 Docker 镜像，要怎么登录和配置？

新手拉取配置

错误码与失败问题

docker pull 提示 manifest unknown 怎么办？

manifest unknown

docker pull 提示 no matching manifest 怎么办？

no matching manifest（架构）

镜像已拉取完成，却提示 invalid tar header 或 failed to register layer 怎么办？

invalid tar header（解压）

Docker pull 时 HTTPS / TLS 证书验证失败怎么办？

TLS 证书失败

Docker pull 时 DNS 解析超时或连不上仓库怎么办？

DNS 超时

Docker 拉取出现 410 Gone 怎么办？

410 Gone 排查

出现 402 或「流量用尽」提示怎么办？

402 与流量用尽

Docker 拉取提示 UNAUTHORIZED（401）怎么办？

401 认证失败

遇到 429 Too Many Requests（请求太频繁）怎么办？

429 限流

docker login 提示 Cannot autolaunch D-Bus，还算登录成功吗？

D-Bus 凭证提示

为什么会出现「单层超过 20GB」或 413，无法加速拉取？

413 与超大单层

账号 / 计费 / 权限

轩辕镜像免费版和专业版有什么区别？

免费版与专业版区别

轩辕镜像支持哪些 Docker 镜像仓库？

支持的镜像仓库

镜像拉取失败还会不会扣流量？

失败是否计费

麒麟 V10 / 统信 UOS 提示 KYSEC 权限不够怎么办？

KYSEC 拦截脚本

如何在轩辕镜像申请开具发票？

申请开票

怎么修改轩辕镜像的网站登录和仓库登录密码？

修改登录密码

如何注销轩辕镜像账户？要注意什么？

注销账户

配置与原理类

写了 registry-mirrors，为什么还是走官方或仍然报错？

mirrors 不生效

怎么用 docker tag 去掉镜像名里的轩辕域名前缀？

去掉域名前缀

如何拉取指定 CPU 架构的镜像（如 ARM64、AMD64）？

指定架构拉取

用轩辕镜像拉镜像时快时慢，常见原因有哪些？

拉取速度原因

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"