edirom/odd-api

ODD API

概述

ODD API是一个小型Web应用，用于提供ODD（Open Document Definition，支持TEI或MEI格式）文件的信息。目前支持MEI 4.0.1和TEI 4.0.0版本，通过REST API接口返回结构化的JSON数据，便于开发者获取ODD文件的元数据和结构信息。

核心功能和特性

• 支持的ODD类型：目前已支持MEI 4.0.1和TEI 4.0.0格式的ODD文件
• REST API端点：提供以下固定端点，返回对应ODD信息的JSON数据：
  • /mei/4.0.1/modules.json
  • /mei/4.0.1/MEI.cmn/elements.json
  • /mei/4.0.1/MEI.cmn/attClasses.json
  • /mei/4.0.1/bracketSpan/atts.json
• 数据存储结构：API路径与应用内部/data文件夹结构对应（如/mei/4.0.1对应/data/mei/4.0.1）
• 扩展性：支持添加自定义ODD格式，只需将相关文件放入/data文件夹的对应路径，应用会自动识别并提供API访问

使用场景和适用范围

适用于需要获取ODD文件（特别是MEI和TEI格式）结构化元数据的开发者，可集成到文档处理工具、学术研究平台或需要ODD规范信息的应用系统中，用于动态获取元素定义、属性类等ODD核心信息。

使用方法和配置说明

部署示例

Docker Run命令

docker
docker run -d -p 8080:80 -v /path/to/local/data:/data --name odd-api edirom/odd-api

• -p 8080:80：将容器80端口映射到主机8080端口（可根据需要修改）
• -v /path/to/local/data:/data：挂载本地数据目录到容器/data，用于存放ODD文件
• --name odd-api：指定容器名称

配置说明

• 数据卷挂载：必须挂载/data目录，其中存放ODD文件的文件夹结构需与API路径对应（例如，/data/mei/4.0.1/MEI.cmn/elements.json对应API端点/mei/4.0.1/MEI.cmn/elements.json）
• 端口配置：默认使用容器80端口，可通过-p参数自定义主机映射端口

添加新ODD格式

1. 在本地/path/to/local/data目录下创建与目标API路径对应的文件夹结构（如添加TEI 5.0.0，需创建/path/to/local/data/tei/5.0.0）
2. 将TEI 5.0.0的ODD数据文件（如modules.json、elements.json等）放入对应子目录
3. 重启容器后，应用会自动识别新路径，通过/tei/5.0.0/modules.json等端点提供数据