neverminedio/marketplace-api

Nevermined Marketplace API

镜像概述和主要用途

Nevermined Marketplace API 是用于管理Marketplace常见功能的API服务，提供Marketplace核心功能的管理能力，支持数据资产交易、查询等相关操作。该镜像基于NodeJS构建，可通过Docker快速部署，适用于搭建和运行Nevermined Marketplace的后端服务。

核心功能和特性

• 提供Marketplace常见功能的API接口
• 支持Elasticsearch数据库集成，用于数据存储和查询
• 包含开发、测试和生产环境的配置支持
• 提供完整的测试框架，包括单元测试和Postman测试
• 模块化架构设计，包含领域模型、通用功能和共享服务

使用场景和适用范围

• 开发和部署Nevermined Marketplace后端服务
• 构建基于Nevermined生态的数据交易平台
• 需要管理Marketplace功能的开发者和技术团队
• 进行Marketplace API功能测试和集成验证

使用方法和配置说明

前置条件

• 已安装Docker（推荐使用Docker Desktop）
• NodeJS 16版本（可通过nvm管理多版本NodeJS）
• 使用yarn作为包管理器

安装依赖

bash
yarn

复制配置文件

bash
yarn setup:dev

执行后将在config文件夹中生成local.js配置文件，用于本地环境配置。

数据库设置

1. 本地运行数据库

• 本地部署Elasticsearch数据库
• 在local.js中配置数据库连接信息：

javascript
elasticsearch: {
  node: '',  // Elasticsearch节点地址
  prefix: '', // 索引前缀
  auth: {
    username: 'elastic',  // 用户名
    password: 'password', // 密码
  }
},

• 可从项目提供方获取初始数据库 dump 数据

2. Docker运行数据库

确保已安装Docker，在项目根目录执行：

bash
docker-compose up

运行和构建

开发环境运行

bash
npm run dev

构建生产环境

bash
npm build

Docker部署示例

docker-compose配置

yaml
version: '3'
services:
  marketplace-api:
    image: neverminedio/marketplace-api
    ports:
      - "3000:3000"  # API服务端口
    environment:
      - NODE_ENV=production
    volumes:
      - ./config/local.js:/app/config/local.js  # 挂载本地配置文件
    depends_on:
      - elasticsearch
  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.14.0
    environment:
      - discovery.type=single-node
      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
    ports:
      - "9200:9200"

目录结构

- src
  - greeting      # 领域模型示例（包含聚合根）
  - common        # 横切功能，如守卫、中间件、拦截器
  - shared        # 共享模块和服务（如Elasticsearch服务）
- config          # 按环境配置文件

测试

单元测试

确保Docker容器运行中（docker-compose up），执行：

bash
yarn setup:dev
yarn test:cov

Postman测试

启动开发服务器：

bash
yarn setup:dev
yarn dev

服务器运行后执行Postman测试：

bash
yarn test:postman

许可证

Copyright 2022 Nevermined AG

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

   [***]

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.