neverminedio/metadata-api

Nevermined Metadata API

镜像概述和主要用途

Nevermined Metadata API提供链下数据库存储，用于管理数据资产的元数据。它支持市场开发、元数据查询与存储，并提供API接口及Swagger文档，可与MongoDB或Elasticsearch集成，适用于需要高效管理数据资产元数据的场景。

核心功能和特性

• 链下元数据存储：作为数据资产元数据的链下数据库，支持高效存储和查询
• 多数据库支持：兼容MongoDB和Elasticsearch，可根据需求选择数据库引擎
• API接口：提供RESTful API，方便与其他系统集成
• Swagger文档：内置API文档，便于用户和开发者使用和调试
• 灵活配置：通过配置文件或环境变量进行参数设置，支持SSL/TLS安全访问

使用场景和适用范围

• 市场开发：开发者构建数据市场时，可本地部署Metadata API及相关组件
• 元数据管理：需要存储和查询数据资产元数据的应用场景
• 开发与测试：开发者本地运行服务进行功能测试和集成开发

使用方法和配置说明

对于Metadata运营商

若开发市场，建议使用Nevermined工具在本地运行Metadata及其他组件，详见https://github.com/nevermined-io/tools%E3%80%82

对于Metadata API用户

若本地运行Metadata服务，可通过以下地址访问API文档：

• http://localhost:5000/api/v1/docs
• [***]

提示：

1. 若访问失败，尝试使用https协议
2. 若Chrome浏览器显示Swagger头部但提示"Failed to load spec"，可在chrome://flags/#allow-insecure-localhost中启用"Allow insecure localhost"并重启浏览器

元数据本体论相关信息详见https://github.com/nevermined-io/internal/tree/master/docs/architecture/specs/metadata%E3%80%82

对于Metadata开发者

通用Keyko开发文档

Keyko的Python代码风格及相关开发文档详见https://github.com/nevermined-io/internal%E3%80%82

本地运行（开发与测试）

1. 克隆仓库：

   bash
   git clone git@github.com:nevermined-io/metadata-api.git
   cd metadata-api/
   

2. 运行数据库：

   • MongoDB（推荐）：

     bash
     docker run -d -p 27017:27017 docker.xuanyuan.run/mongo
     

   • Elasticsearch：修改config.ini配置文件，使用偏好的方式启动Elasticsearch

3. 安装系统依赖：

   bash
   sudo apt update
   sudo apt install python3-dev python3.7-dev libssl-dev
   

   注：python3-dev适用于Python 3.6，若需本地测试Python 3.7，需安装python3.7-dev

4. 创建并激活虚拟环境，然后安装Python依赖：

   bash
   pip install -r requirements_dev.txt
   

5. 启动服务：

   • 使用Flask（HTTP）：

     bash
     export FLASK_APP=nevermined_metadata/run.py
     export CONFIG_FILE=config.ini
     flask run
     

   • 使用Gunicorn（支持SSL/TLS）：
     1. 生成测试证书：

        bash
        openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365
        

        提示：证书生成时，Common Name (CN) 填写localhost

     2. 修改config.ini：

        yaml
        [resources]
        metadata.url = http://localhost:5000
        

     3. 启动Gunicorn：

        bash
        gunicorn --certfile cert.pem --keyfile key.pem -b 0.0.0.0:5000 -w 1 nevermined_metadata.run:app
        

配置

通过CONFIG_FILE环境变量指定配置文件（推荐），或使用默认的config.ini文件。配置文件包含以下部分：

• metadatadb：数据库连接配置，详见https://github.com/nevermined-io/metadata-driver-interface
• resources：Metadata服务部署URL配置

  yaml
  [resources]
  metadata.url = http://localhost:5000
  

测试

通过GitHub Actions进行自动化测试，使用pytest框架。

版本管理

使用bumpversion.sh脚本更新项目版本，参数为{major|minor|patch}：

bash
./bumpversion.sh major  # 主版本号更新
./bumpversion.sh minor  # 次版本号更新
./bumpversion.sh patch  # 补丁版本号更新

归属

本项目基于https://github.com/oceanprotocol/aquarius%E5%BC%80%E5%8F%91%EF%BC%8C%E4%BF%9D%E7%95%99Apache v2许可证并增加了部分改进，详见NOTICE文件。

许可证

Copyright 2020 Keyko GmbH
This product includes software developed at
BigchainDB GmbH and Ocean Protocol ([***]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.