clinicalgenomics/loqusdbapi

镜像概述

本镜像提供一个轻量级REST API服务，专门用于与loqusdb进行交互。loqusdb是一个用于存储和查询基因组变异频率数据的工具，广泛应用于生物信息学领域。该API服务简化了与loqusdb的集成流程，允许用户通过标准HTTP请求访问、查询和管理loqusdb中的变异数据，无需直接操作loqusdb命令行工具。

核心功能与特性

• RESTful接口：遵循REST设计原则，提供直观的API端点，支持标准HTTP方法（GET、POST等）。
• loqusdb数据交互：无缝对接loqusdb，支持变异频率查询、数据统计、样本信息管理等核心操作。
• 轻量级部署：镜像体积小巧，启动快速，适合嵌入各类生物信息学分析流程。
• 灵活配置：支持通过环境变量自定义服务端口、loqusdb连接参数等配置项。

使用场景

• 生物信息学分析平台中，需要通过API接口访问loqusdb变异数据的场景。
• 自动化分析流程中，需集成loqusdb数据查询功能的 pipeline。
• 多用户共享loqusdb资源时，提供统一的API访问入口。

使用方法

前提条件

• 已部署loqusdb服务或可访问的loqusdb数据库文件。
• 安装Docker环境。

启动容器

通过以下命令启动API服务容器，默认暴露端口5000：

bash
docker run -d -p 5000:5000 --name loqusdb-api -v /path/to/loqusdb/data:/loqusdb/data loqusdb-api:latest

参数说明：

• -p 5000:5000：端口映射，将容器内5000端口映射到主机5000端口（可根据需求修改主机端口）。
• -v /path/to/loqusdb/data:/loqusdb/data：挂载loqusdb数据库目录到容器内，确保API能访问loqusdb数据。
• --name loqusdb-api：指定容器名称，便于管理。

环境变量配置

可通过-e参数设置环境变量，自定义服务配置：

示例（自定义端口和日志级别）：

bash
docker run -d -p 8080:8080 -e PORT=8080 -e LOG_LEVEL=DEBUG -v /data/loqusdb:/loqusdb/data loqusdb-api:latest

API使用示例

查询变异频率

通过GET请求查询特定变异的频率数据：

bash
curl http://localhost:5000/api/v1/variants?chrom=chr1&position=12345&ref=A&alt=T

添加样本数据

通过POST请求向loqusdb添加样本变异数据：

bash
curl -X POST -H "Content-Type: application/json" -d '{"sample_id": "sample1", "variants": [{"chrom": "chr1", "pos": 12345, "ref": "A", "alt": "T"}]}' http://localhost:5000/api/v1/samples

注意事项

• 确保挂载的loqusdb数据库路径正确且容器具有读写权限。
• 生产环境中建议配合反向代理（如Nginx）使用，并启用身份验证机制。
• API服务默认不加密传输，敏感环境下需配置HTTPS。