timoreymann/schemanest-registry

SchemaNest

镜像概述

SchemaNest是一个用于集中管理JSON模式的工具，旨在为团队提供简单、灵活且轻量级的JSON模式管理解决方案。它支持模式的上传与版本控制，提供Web界面用于浏览和搜索模式，并配备CLI工具方便命令行操作，同时确保对屏幕阅读器和视障用户的无障碍支持。

核心功能与特性

• JSON模式管理：支持上传和版本化JSON模式至中央仓库
• Web界面：提供直观的Web界面，用于浏览和搜索已存储的模式
• CLI工具：通过命令行工具实现模式上传等操作
• 无障碍支持：默认支持屏幕阅读器，确保视障用户可访问
• 灵活部署：支持Postgres数据库（生产环境）和SQLite（评估/小型实例）

环境要求

• 数据库：生产环境推荐使用Postgres；SQLite仅建议用于评估和小型实例

安装与使用

CLI工具

Docker方式

bash
docker run --rm -it -v $PWD:/workspace:ro -w /workspace \
  timoreymann/schemanest-cli schema-nest-cli \
  --help

Registry服务

使用docker-compose部署

1. 创建config.toml配置文件：

toml
# 数据库连接配置
database_dsn = "postgres://schema-nest:schema-nest@db/schema-nest"

# 启用上传认证
enable_upload_authentication = true

# API密钥配置
[[api_keys]]
identifier = "frontend"
# 请设置为安全的密钥（UUID、哈希等）
key = "my-super-secret-api-key"
patterns = [
  # 允许所有以@frontend/为前缀的模式
  "@frontend/*",
  # 允许特定模式mjml-config
  "mjml-config"
]

2. 创建docker-compose.yaml：

yaml
services:
  registry:
    image: timoreymann/schemanest-registry
    command:
      - schema-nest-registry
      - serve-http
      - -C
      - /etc/SchemaNest/config.toml
    volumes:
      - ./config.toml:/etc/SchemaNest/config.toml
    ports:
      - 8080:8080
  db:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: schema-nest
      POSTGRES_USER: schema-nest
      POSTGRES_PASSWORD: schema-nest
    volumes:
      - schema-nest-db-data:/var/lib/postgresql/data
    restart: always
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"]
      interval: 5s
      timeout: 5s
      retries: 5
volumes:
  schema-nest-db-data:

3. 启动服务：

bash
docker compose up

4. 访问Web界面：http://localhost:8080

基本使用

CLI工具

查看帮助信息：

bash
schema-nest-cli --help

Registry服务

启动HTTP服务器（默认监听0.0.0.0:8080）：

bash
schema-nest-registry serve-http --port "8080"

使用场景

• 团队协作：集中管理团队共享的JSON模式，确保版本一致性
• API开发：统一管理API请求/响应的JSON模式，便于文档和验证
• 前端开发：存储UI组件配置、表单验证等JSON模式，支持版本回溯
• 小型项目：作为轻量级替代方案，避免复杂的模式管理系统

配置说明

核心配置参数（config.toml）

API文档

API定义基于OpenAPI 3.0，最新规范可查看https://github.com/timo-reymann/SchemaNest/blob/main/openapi.yml%E3%80%82Redocly UI文档可访问https://timo-reymann.github.io/SchemaNest/apidocs.html%EF%BC%88%E5%BC%80%E5%8F%91%E7%89%88%E6%9C%AC%EF%BC%89%E3%80%82API%E5%8F%98%E6%9B%B4%E4%BF%9D%E6%8C%81%E5%90%91%E5%90%8E%E5%85%BC%E5%AE%B9%EF%BC%8C%E5%BB%BA%E8%AE%AE%E5%AE%A2%E6%88%B7%E7%AB%AF%E4%BB%A3%E7%A0%81%E5%85%BC%E5%AE%B9%E9%A2%9D%E5%A4%96%E5%AD%97%E6%AE%B5%E3%80%82