pLannotate FastAPI Docker镜像文档

镜像概述

本Docker镜像封装了基于FastAPI框架的应用程序，旨在简化pLannotate工具的部署与使用流程。通过容器化方式，用户可快速搭建具备API接口的pLannotate运行环境，无需手动配置Python依赖及相关组件，实现即开即用的工具访问体验。

核心功能与特性

• FastAPI支持：集成高性能Python API框架FastAPI，提供RESTful接口访问pLannotate功能
• 简化部署：容器化设计消除环境依赖问题，一键启动即可使用pLannotate工具
• 轻量高效：优化镜像体积，确保资源占用低，运行效率高
• 标准化接口：通过FastAPI自动生成的API文档（/docs或/redoc路径），便于接口调试与集成

使用场景与适用范围

• 需要快速部署pLannotate工具进行分析的科研人员
• 开发人员需将pLannotate功能集成到现有应用系统中
• 教学或演示环境中快速搭建pLannotate示例服务
• 对环境一致性有要求的自动化工作流场景

使用方法与配置说明

基本部署

使用以下命令拉取并运行镜像（需替换[镜像名称]为实际镜像标识）：

docker run -d -p 8000:8000 --name plannotate-api [镜像名称]

参数说明：

• -d：后台运行容器
• -p 8000:8000：将容器内8000端口（FastAPI默认端口）映射到主机8000端口
• --name plannotate-api：指定容器名称为plannotate-api

访问API服务

容器启动后，通过以下地址访问pLannotate API服务：

• API端点：http://localhost:8000
• 交互式API文档：http://localhost:8000/docs
• 备用API文档：http://localhost:8000/redoc

配置说明

当前版本镜像未提供额外可配置环境变量，默认配置下即可正常运行。如需自定义配置（如修改端口、调整日志级别等），可通过以下方式实现：

1. 构建时修改：基于原镜像创建Dockerfile，通过ENV指令设置环境变量
2. 运行时挂载：将自定义配置文件挂载至容器内指定路径（具体路径需参考镜像内部应用结构）

容器管理

• 查看运行状态：docker ps --filter "name=plannotate-api"
• 停止容器：docker stop plannotate-api
• 重启容器：docker restart plannotate-api
• 查看日志：docker logs plannotate-api

注意事项

• 确保主机8000端口未被占用，或通过-p [主机端口]:8000调整映射端口
• 生产环境建议添加数据卷挂载，以持久化存储必要数据
• 高并发场景下可结合反向代理（如Nginx）使用，提升服务稳定性