lukaslohoff/o2r-badger

o2r badger

API服务，用于获取科学出版物的可扩展徽章，支持集成到研究聚合平台（如通过Chrome扩展o2r-extender）。基于明斯特大学ifgi的研究项目，感谢贡献团队。

核心功能

徽章类型

• executable：出版物的可执行性和可复现性信息
• licence：许可证类型
• spatial：研究发生的空间位置
• releasetime：发布日期
• peerreview：同行评审状态

依赖服务

• o2r（提供executable、licence、location信息）
• crossref（提供releasetime信息）
• DOAJ（提供peerreview信息）
• GeoNames（空间信息反向地理编码）

使用场景

1. 研究人员查询出版物的可复现性状态
2. 集成到浏览器扩展（如o2r-extender）在研究聚合平台显示徽章
3. 自动生成出版物的合规性或元数据徽章

部署说明

1. Docker Hub直接运行

bash
docker run -it -e DEBUG=* -p 8089:8089 docker.xuanyuan.run/o2rproject/o2r-badger

2. 本地构建Docker镜像

bash
git clone https://github.com/o2r-project/o2r-badger
cd o2r-badger
docker build -t badger .
docker run -it -e DEBUG=* -p 8089:8089 docker.xuanyuan.run/badger

3. Node.js运行

bash
git clone https://github.com/o2r-project/o2r-badger
cd o2r-badger
npm install --production
DEBUG=* npm start

服务启动后可通过http://localhost:8089/访问，安装o2r-extender扩展可在研究聚合平台显示徽章。

配置说明

通过环境变量配置（默认值见括号）：

• BADGER_PORT：服务监听端口（8089）
• BADGER_O2R_HOST：o2r API地址（[***]
• DISABLE_TRACKING：禁用Piwik跟踪（false）
• PIWIK_TOKEN：Piwik跟踪令牌

其他配置可修改config/config.js，如代理、外部服务端点等。

API示例

GET请求（同行评审徽章，小型）

bash
curl http://localhost:8089/api/1.0/badge/peerreview/10.5194%2Fgmdd-8-3905-2015

返回小型绿色徽章（表示同行评审通过）。

POST请求（许可证徽章，扩展型）

bash
curl -o output.svg -H "Content-Type: application/json" --data '{  
   "id":"opxYU",
   "created":"2016-08-19T13:59:13.134Z",
   "metadata":{  
      "licence":{  
         "data":"Against-DRM",
         "text":"CC-BY-4.0",
         "code":"AAL"
      }
   }
}' http://localhost:8089/api/1.0/badge/licence/extended

返回扩展型许可证徽章。

许可证

本项目采用https://www.apache.org/licenses/LICENSE-2.0%E6%8E%88%E6%9D%83%E3%80%82