Central Dogma REST API 完全参考让配置管理实现自动化【免费下载链接】centraldogmaHighly-available version-controlled service configuration repository based on Git, ZooKeeper and HTTP/2项目地址: https://gitcode.com/gh_mirrors/ce/centraldogmaCentral Dogma 是一个基于 Git、ZooKeeper 和 HTTP/2 构建的高可用、版本化服务配置管理仓库专为存放 JSON、YAML、XML 等配置而设计。它提供了完整的Central Dogma REST API让团队可以用curl、脚本或任何编程语言轻松读取配置、提交变更、回滚历史真正实现配置管理的自动化。本文是一份面向新手和普通用户的Central Dogma REST API 完全参考从端点概览到实战示例一次讲透。Central Dogma REST API 基础端点、版本与认证所有 REST 接口统一挂在/api/v1前缀下服务端默认监听36462端口。核心实现位于服务端的 ProjectServiceV1.java、ContentServiceV1.java 等文件中。调用前你只需记住三个概念路径语法采用 Unix 风格/projFoo是项目/projFoo/repoA是仓库/projFoo/repoA/samples/a.json是文件。Revision修订号-1表示最新版本1、2等正整数表示历史版本几乎所有读接口都支持revision参数。认证启用安全模式后通过Authorization: Bearer token请求头携带令牌。# 快速自检列出所有项目 curl http://localhost:36462/api/v1/projects项目管理 API一键创建与删除项目是配置的顶层隔离单元。常用端点如下方法端点用途GET/api/v1/projects列出全部项目POST/api/v1/projects创建项目GET/api/v1/projects/{name}查看单个项目DELETE/api/v1/projects/{name}删除项目可恢复curl -X POST http://localhost:36462/api/v1/projects \ -H Content-Type: application/json \ -d {name: projFoo}前端 apiSlice.ts 中对项目增删查的封装与上述端点一一对应可作为接入参考。仓库管理 API在项目内组织配置仓库类似于 Git 仓库一个项目可包含多个仓库分别存放不同环境的配置。方法端点用途GET/api/v1/projects/{proj}/repos列出项目下所有仓库POST/api/v1/projects/{proj}/repos创建仓库DELETE/api/v1/projects/{proj}/repos/{repo}删除仓库curl -X POST http://localhost:36462/api/v1/projects/projFoo/repos \ -H Content-Type: application/json \ -d {name: repoA}文件内容 API读取、写入与 JSONPath 查询这是 Central Dogma REST API 中最高频的一组接口对应服务端 ContentServiceV1.java。列出目录GET /api/v1/projects/{proj}/repos/{repo}/list{/path}读取文件GET /api/v1/projects/{proj}/repos/{repo}/contents{/path}?revision-1提交更改POST /api/v1/projects/{proj}/repos/{repo}/contents预览模板POST /api/v1/projects/{proj}/repos/{repo}/preview读取文件时还支持jsonpath参数直接从 JSON 配置中提取字段无需下载全文curl http://localhost:36462/api/v1/projects/projFoo/repos/repoA/contents/samples/a.json?jsonpath$.a写入文件必须携带commitMessage每次变更都会生成一条带版本号的提交记录curl -X POST http://localhost:36462/api/v1/projects/projFoo/repos/repoA/contents \ -H Content-Type: application/json \ -d {commitMessage: 更新数据库连接串, changes: [{path: /samples/a.json, type: UPSERT, content: {\a\:\b\}}]}提交历史与回滚 API让配置变更可追溯配置管理自动化的核心价值在于可审计、可回滚。相关端点包括方法端点用途GET/api/v1/projects/{proj}/repos/{repo}/commits查看提交历史GET/api/v1/projects/{proj}/repos/{repo}/compare对比两个版本差异POST/api/v1/projects/{proj}/repos/{repo}/revert回滚到指定版本# 将仓库回滚到 revision 3 curl -X POST http://localhost:36462/api/v1/projects/projFoo/repos/repoA/revert \ -H Content-Type: application/json \ -d {revision: 3, commitMessage: 回滚配置}结合watch监听机制服务端还可以在配置变更时实时通知客户端实现配置热更新无需重启服务。模板与变量 API动态生成环境配置Central Dogma 支持${vars.varName}模板语法可将环境差异抽取为变量文件用同一份模板渲染出 dev、prod 等多套配置。官方文档 templates-variables.rst 中有详细说明Web 管理界面也提供了可视化编辑。权限与元数据 API精细的访问控制多团队协作时权限管理必不可少。/api/v1/metadata/...系列接口由 MetadataApiService.java 提供服务成员管理POST /api/v1/metadata/{proj}/members仓库角色POST /api/v1/metadata/{proj}/repos/{repo}/roles/users应用身份POST /api/v1/metadata/{proj}/appIdentities支持项目级与仓库级的细粒度角色Owner、Write、Read并能管理用户、应用身份与令牌三类主体兼顾人工与自动化场景。镜像管理 API从外部 Git 同步配置如果你的团队习惯在 GitLab/GitHub 上通过 Pull Request 评审配置Central Dogma 的镜像Mirror功能可以把外部仓库自动同步进来。相关接口位于 MirroringServiceV1.java方法端点用途GET/api/v1/projects/{proj}/repos/{repo}/mirrors查看镜像配置POST/api/v1/projects/{proj}/repos/{repo}/mirrors创建镜像POST/api/v1/projects/{proj}/repos/{repo}/mirrors/{id}/run手动触发一次同步镜像成功后配置即具备高可用、可查询、可监听、可鉴权四大能力且全程通过 REST API 驱动天然适合接入 CI/CD 流水线。实战用 curl 实现配置自动化闭环把上面的接口串起来只需几条命令就能完成更新配置 → 验证 → 监听变更的自动化闭环# 1. 写入新配置 curl -X POST .../api/v1/projects/projFoo/repos/repoA/contents \ -d {commitMessage: 调整限流阈值, changes: [{path: /config/rate-limit.json, type: UPSERT, content: {\qps\: 500}}]} # 2. 读取最新配置并校验 curl .../api/v1/projects/projFoo/repos/repoA/contents/config/rate-limit.json # 3. 发现异常立即回滚 curl -X POST .../api/v1/projects/projFoo/repos/repoA/revert \ -d {revision: -2, commitMessage: 回滚限流配置}如果想要本地复现与二次开发可克隆仓库获取完整源码https://gitcode.com/gh_mirrors/ce/centraldogma。命令行工具dogma的用法ls、cat、put、watch等可参考 client-cli.rst它与 REST API 的能力一一对应非常适合快速联调。总结Central Dogma REST API 覆盖了配置管理全生命周期项目与仓库的组织、文件读写与查询、历史审计与回滚、模板渲染、权限控制、镜像同步。掌握这份参考你就能用脚本把分散在各处的配置文件统一收拢到高可用的版本化仓库中让配置变更变得可评审、可追踪、可回滚——这就是配置管理自动化的正确打开方式。【免费下载链接】centraldogmaHighly-available version-controlled service configuration repository based on Git, ZooKeeper and HTTP/2项目地址: https://gitcode.com/gh_mirrors/ce/centraldogma创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考