aafcbicoe/natural-history-collection-api

自然历史收藏API Docker镜像

概述

natural-history-collection-api是由AAFC-BICoE开发的应用程序接口服务，旨在提供对自然历史收藏品数据的标准化访问。该API允许用户查询、检索和管理生物标本、样本记录及其相关元数据，支持科研、教育和收藏管理等多种用途。

核心功能与特性

• 提供标准化RESTful API接口，用于访问自然历史收藏数据
• 支持生物标本、样本记录的查询与检索
• 提供元数据管理功能，包括分类学信息、采集地点、采集时间等
• 实现数据过滤、排序和分页功能
• 支持数据导出功能，便于进一步分析和处理
• 提供权限控制机制，确保数据访问的安全性

使用场景与适用范围

• 自然历史博物馆和收藏机构的数据管理系统
• 科研机构生物多样性研究数据访问接口
• 教育机构教学资源提供
• 生物标本数字化项目的数据共享平台
• 生态和环境研究的数据获取工具

使用方法

基本使用

使用以下命令启动API服务容器：

bash
docker run -d -p 8080:8080 --name nhc-api docker.xuanyuan.run/aafcbicoe/natural-history-collection-api

Docker Compose配置

推荐使用docker-compose进行部署，创建docker-compose.yml文件：

yaml
version: '3'
services:
  nhc-api:
    image: docker.xuanyuan.run/aafcbicoe/natural-history-collection-api
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - DATABASE_URL=jdbc:postgresql://db:5432/nhc_db
      - DATABASE_USERNAME=nhc_user
      - DATABASE_PASSWORD=secure_password
    depends_on:
      - db
    restart: unless-stopped
  
  db:
    image: docker.xuanyuan.run/postgres:13
    volumes:
      - postgres_data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=nhc_db
      - POSTGRES_USER=nhc_user
      - POSTGRES_PASSWORD=secure_password
    restart: unless-stopped

volumes:
  postgres_data:

启动服务：

bash
docker-compose up -d

配置说明

环境变量

API文档访问

服务启动后，可通过以下URL访问API文档：

• Swagger UI: http://localhost:8080/swagger-ui.html
• API文档JSON: http://localhost:8080/v3/api-docs

数据持久化

建议使用外部数据库或挂载卷来持久化数据，以确保容器重启后数据不丢失。如上面的docker-compose示例所示，使用PostgreSQL数据库并挂载数据卷。

维护与支持

该项目由AAFC-BICoE维护，源代码托管于GitHub: https://github.com/AAFC-BICoE/natural-history-collection-api

如需报告问题或请求功能，请在GitHub仓库提交issue。