registry/README.md

50 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Registry - 微服务配置管理中心
基于 Web 的注册表风格微服务配置管理系统。以项目为单位管理配置,支持机房、环境、分组三个维度划分,提供规划、编辑、只读三种工作模式。
## 快速开始
```bash
npm install
npm start
```
启动后访问 http://localhost:3000
## 功能概览
- **项目管理**:以项目为单位隔离配置;维度开关(机房/环境/分组)创建时确定,后续不可修改。
- **注册表风格界面**:左侧树形导航(项目 → 机房 → 环境 → 分组 → 配置),右侧键值详情表格。
- **配置项**:路径形式的 keyvalue 支持 string/number/boolean/json 类型,每项必须有说明。
- **三种模式**
- 规划模式:定义配置结构(类型、说明、用途、值范围)。
- 编辑模式:填写/修改配置值,含类型与范围校验。
- 只读模式:仅查看,禁止修改。
- **持久化**:当前实现 JSON 文件方案,支持导出下载与导入合并。持久化层已抽象,后续可扩展 XML / YAML / SQLite / MySQL / Nacos。
## 文档
- 需求文档:`docs/requirements.md`
- 概要设计文档:`docs/design.md`
## 目录结构
```
registry/
├── docs/ 需求与设计文档
├── data/ JSON 持久化数据
├── src/ 后端源码Express
│ ├── server.js
│ ├── routes/ 项目与配置路由
│ ├── services/ 业务逻辑
│ ├── persistence/ JSON 持久化适配器
│ └── utils/ 配置值校验
└── public/ 前端静态资源
```
## 后续规划
- 对接 SSO 单点登录(当前版本无认证)。
- 扩展更多持久化方案数据库、Nacos、SSH 远程配置文件)。
- 项目维度转换机制。