Oinone Pamirs 后端框架技术文档

1. 安装指南

1.1 环境准备

• 开发环境要求：
  • JDK 1.8+
  • Maven 3.5+
  • MySQL 5.7+/PostgreSQL 10+
  • Redis 5.0+

1.2 源码安装（社区版）

1. 克隆仓库：

   git clone https://github.com/oinone/oinone-pamirs.git
   

2. 构建项目：

   mvn clean install
   

3. 初始化数据库：
   • 执行sql/init.sql脚本
   • 修改application.yml中的数据库配置

1.3 Docker安装（企业版）

• 完整版安装：

  docker-compose -f docker-compose-full.yml up -d
  

• 精简版安装：

  docker-compose -f docker-compose-mini.yml up -d
  

2. 项目使用说明

2.1 启动项目

• 开发模式：

  mvn spring-boot:run
  

• 生产模式：

  java -jar pamirs-boot/target/pamirs-boot-*.jar
  

2.2 系统访问

• 默认管理后台：
  • 地址：http://localhost:8080/admin
  • 账号：admin
  • 密码：admin

2.3 核心功能模块

1. 元数据管理：通过pamirs-k2模块实现
2. 框架核心：pamirs-framework提供基础架构支持
3. 中间件集成：pamirs-middleware封装常用中间件
4. 扩展适配：pamirs-framework-adaptor支持第三方系统对接

3. API使用文档

3.1 基础API规范

• 请求格式：RESTful风格
• 认证方式：JWT Token
• 响应格式：

  {
    "code": 200,
    "message": "success",
    "data": {}
  }
  

3.2 核心API示例

元数据查询API

GET /api/v1/metadata/{modelName}
Headers:
  Authorization: Bearer {token}

业务数据操作API

POST /api/v1/data/{modelName}
Headers:
  Authorization: Bearer {token}
Body:
  {
    "field1": "value1",
    "field2": "value2"
  }

3.3 自定义API开发

1. 在pamirs-core模块创建Controller
2. 使用@PamirsApi注解标记接口
3. 通过MetadataService访问元数据系统

4. 项目安装方式对比

安装方式	适用版本	特点	推荐场景
源码安装	社区版	需要自行编译，灵活性高	开发/二次开发环境
Docker完整安装	企业版	包含全部组件，一键部署	生产环境
Docker精简安装	企业版	仅包含核心服务，资源占用少	演示/测试环境
包安装	企业版	提供离线安装包，适合内网环境	无外网访问权限的环境

5. 项目结构说明

oinone-pamirs/
├── pamirs-k2                # 元数据核心
├── pamirs-framework         # 框架核心包
├── pamirs-framework-commons # 公共工具包
├── pamirs-framework-adaptor # 扩展适配包
├── pamirs-spi              # 服务接口定义
├── pamirs-boot             # 启动入口
├── pamirs-core             # 通用功能实现
└── pamirs-middleware       # 中间件集成