coco/document-store-api

自动构建

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

0 次下载activecoco镜像

🚀轩辕镜像专业版更稳定💎一键安装 Docker 配置镜像源

中文简介版本下载

🚀轩辕镜像专业版更稳定💎一键安装 Docker 配置镜像源

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:***/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": "[***]"
        }
    ],
    "identifiers": [
        {
            "authority": "[***]",
            "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=\"[***]\"></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:***/content/{uuid}
请求头：Content-Type: application/json

获取内容（GET）

单条获取：GET http://localhost:***/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:***/content?uuid={uuid1}&uuid={uuid2}...，受URI长度限制（2083字符）

按标识符查询内容

请求URL：GET http://localhost:***/content-query?identifierAuthority={authority}&identifierValue={identifierValue}
响应码：
- 301：找到单条文档，Location头包含文档URI
- 404：未找到匹配文档
- 500：找到多条文档（非预期情况）
示例请求：GET /content-query?identifierAuthority=[***] HTTP/1.1

列表操作（List）

创建/更新列表（PUT）

请求URL：http://localhost:***/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": "[***]"
        }
    ]
}

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

获取列表（GET）

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