fairdata/fairdatapoint

FAIR Data Point

镜像概述与主要用途

FAIRDataPoint 是一个REST API，用于创建、存储和提供FAIR元数据。元数据内容根据FAIR Data Point软件规范文档半自动生成。更多关于FDP及部署的信息可参考https://fairdatapoint.readthedocs.io/%E3%80%82

核心功能与特性

• REST API接口：提供创建、存储和提供FAIR元数据的完整功能
• 半自动元数据生成：元数据内容根据FAIR Data Point软件规范自动生成
• 访问控制机制：大部分GET请求公开可访问，POST、PUT和PATCH等写操作需安全认证
• 安全认证：采用JWT令牌（JWT Tokens）和Bearer Token认证（Bearer Token Authentication）
• 嵌入式API文档：集成Swagger文档，便于查看和使用API调用详情

使用场景与适用范围

适用于需要管理和提供符合FAIR原则元数据的场景，包括但不限于：

• 研究机构的数据管理平台
• 开放数据仓库系统
• 科学数据共享平台
• 各类需要确保元数据FAIR性的数据服务

使用方法与配置说明

构建Docker镜像

从项目根目录执行以下命令构建Docker镜像：

bash
$ docker build -t fairdata/fairdatapoint .

运行应用

从项目根目录使用Maven启动应用（需先安装依赖）：

bash
$ mvn spring-boot:start

运行测试

从项目根目录执行测试命令：

bash
$ mvn test

打包应用

从项目根目录打包应用：

bash
$ mvn package

安全说明

访问权限控制

• 公开访问：大部分GET请求公开可访问
• 受限操作：POST、PUT和PATCH等写操作需要安全认证

认证方式

通过/tokens端点获取JWT令牌，需提交用户名和密码。采用JWT令牌（JWT Tokens）和Bearer Token认证（Bearer Token Authentication）。

默认用户

• 管理员（ADMIN）：
  • 用户名：albert.einstein@example.com
  • 密码：password
• 普通用户（USER）：
  • 用户名：nikola.tesla@example.com
  • 密码：password

API文档

FAIRDataPoint（FDP）API集成嵌入式http://swagger.io/%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87Web%E6%B5%8F%E8%A7%88%E5%99%A8%E8%AE%BF%E9%97%AE%E4%BB%A5%E4%B8%8BURL%E6%9F%A5%E7%9C%8BAPI%E8%AF%A6%E6%83%85%EF%BC%9A

http://localhost:8080/swagger-ui.html

许可证

本项目采用MIT许可证 - 详见LICENSE文件了解更多详情。