参考指南（Reference）

后端API（Back-End framework）

• Module API
  • 模块 Module
  • 模块生命周期
  • 模块启动
• ORM API
  • 模型 Model
  • 字段 Field
  • 枚举与数据字典
  • 模型继承
  • Common ORM Methods
  • 持久层操作
  • 异常处理
• Functions API
  • 函数定义
  • Extpoint 扩展点
  • Hook 拦截器
  • Trigger 触发器
  • 内置函数
  • 表达式
  • 事务控制
• Actions API
  • 服务器动作 ServerAction
  • 窗口动作 ViewAction
  • 跳转动作 UrlAction
  • 客户端动作 ClientAction
• UX API
  • 应用相关
  • 菜单相关注解
  • 视图相关注解
  • 按钮相关注解
  • 动作相关注解
• Security in Oinone
  • 概念介绍
  • 模块过滤
  • 动作/函数过滤
  • 自定义权限树并通过页面授权
  • 自定义数据过滤
• Advance API
  • 网关协议 API
    • GraphQL 协议详解
    • RSQL 协议详解
    • GraphQL 与 RESTful 的优势对比
    • Variables 变量
    • 占位符 PlaceHolder
  • Request Context API
    • PamirsSession
    • RequestContext
    • 会话构建流程（HTTP 请求处理）
    • 示例代码
  • 元位指令 API
    • 数据指令
    • 请求上下文指令
    • 元位指令使用模式
  • Hint API
    • 指定数据源 DsHint
    • 指定批次数量 BatchSizeHint
  • Message Hub API
    • 成员变量
    • 构造方法
    • 核心方法
    • 消息级别(InformationLevelEnum）
    • 示例代码
    • 注意事项
    • 类图（简略）
  • FileClient API
    • 概述
    • 方法说明
    • 完整示例
    • 数据结构 CdnFile
    • 注意事项
    • 支持的存储服务
  • 消息队列 MQ API
    • 依赖与YAML配置
    • 核心接口
    • 使用示例
    • 高级特性
    • 不同中间件差异处理
    • 常见问题
  • Redis API
    • 基础使用
    • 最佳实践
    • 核心配置源码解析
  • ES API
    • EnhanceModel 使用指南
    • 基础配置
    • 常见问题
  • Tools API
    • IdGenerator 接口（ID 生成器）
    • UidGenerator 接口（唯一 ID 生成器）
    • SequenceGenerator 接口文档
    • RSQLHelper 类（RSQL 解析工具类）
    • RsqlParseHelper 类（RSQL 转 SQL 工具类）
    • ObjectUtils 类（对象工具类）
    • PamirsJsonUtils 类（用于前端交互）

前端API（Front-End framework）

• 框架概览
  • 技术栈说明
  • 代码结构
  • Web 客户端架构
  • Environment
  • Context
  • 组成部分（Building Blocks）
  • Expression
  • 域（Domains）
• 环境
  • 编译时环境配置
  • 运行时环境配置
  • 自定义运行时配置
  • VueOioProvider 入口配置
  • Reference List
• 上下文
  • 运行时上下文（RuntimeContext）
  • Reference List
• 组件
  • Component Lifecycle
    • Vue 组件生命周期
    • Widget 生命周期
    • Reference List
  • Basic
    • 核心组件图谱
    • SPI Token 组件图谱
    • 元数据组件图谱
    • Reference List
  • Mask
    • 内置母版（Mask）
    • 母版组件
    • 母版组件的注册
    • 注册母版
    • Reference List
  • Layout
    • 内置布局
    • 布局组件
    • 插槽
    • 注册布局
  • DSL
    • Vue 插槽
    • DSL 插槽
    • DSL 合并
    • 组件插槽
    • 默认视图与设计视图的区别
  • View
  • Element
    • 元素组件图谱
    • 元素组件的注册
    • Reference List
  • Pack
    • Pack 组件图谱
    • Pack 组件的注册
    • 常见布局和容器组件的使用
    • Reference List
  • Action
    • 动作组件的注册
    • Reference List
  • Field
    • Table Field
    • Search Field
    • Form Field
    • Detail Field
    • Gallery Field
  • Router
    • 路由组件的注册
    • Reference List
• Oio 组件
  • Vue UI Antd
    • 通用
    • 布局
    • 导航
    • 数据录入
    • 数据展示
    • 反馈
  • Vue UI El
    • 数据展示
  • Vue UI
    • Table 表格
• 服务
  • Metadata Service
    • 元数据图示
    • 如何获取运行时元数据
    • Reference List
  • SPI Service
    • 概述
    • SPI API
    • 使用 SPI Service 抽象业务逻辑
    • 使用 SPI Storage 进行维度存储
    • 使用 SPIOperator 进行维度存储
  • Router Service
    • 内置路由
    • 自定义路由
    • 常见用法
    • Reference List
  • GraphQL Service
    • GraphQL 协议
    • 使用可视化工具发起请求
    • GraphQL 在 Oinone 中的使用
    • GQL 工具类的使用
  • RSQL Service
    • RSQL 协议
    • RSQL 工具类的使用
  • HttpClient Service
  • Message Hub Service
  • Event Bus Service
  • Stream Service
    • 概述
    • 在 Widget 组件中使用 RxJS
  • Expression Service
    • 概述
    • 在 Widget 组件中使用表达式
    • 表达式语法
  • Translate Service
    • 在 Widget 组件中使用翻译函数
    • 在 Vue Template 中使用翻译函数
    • 变量处理
    • 获取翻译文件地址格式

User interface

• 视图架构（View architectures）
  • 表格（Table）
    • 视图特征
    • DSL 结构
    • 默认字段组件
    • 可选字段组件
    • DSL 属性配置
  • 表单（Form）
    • 视图特征
    • DSL 结构
    • 默认字段组件
    • 可选字段组件
    • DSL 属性配置
  • 详情（Detail）
    • 视图特征
    • DSL 结构
    • 默认字段组件
    • 可选字段组件
    • DSL 属性配置
  • 画廊（Gallery）
    • 视图特征
    • DSL 结构
    • 默认字段组件
    • 可选字段组件
    • DSL 属性配置
  • 树（Tree）
    • 视图特征
    • DSL 结构
    • 节点配置示例
• UI icons

标准模块（Standard modules）

• 用户与商业主体 API（User & Business API）
  • 概述
  • 常见示例
  • 更多常用 API
• 消息 API（Message API）
  • 概述
  • 准备工作
  • 消息配置
  • API 使用说明
• 工作流（Workflow）
  • 概述
  • 依赖设置
  • 工作流 API 介绍
• 文件导入导出（Import And Export）
  • 概述
  • 准备工作
  • Yaml 配置
  • 创建模板
  • 自定义导入/导出逻辑
  • Reference List
• 资源 API（Resources API）
  • 概述
  • 依赖与配置
  • Reference List
• 集成接口 API（EIP API）
  • 概述
  • 准备工作
  • @Open 注解
  • @Integrate 注解
  • 核心处理函数
  • 完整调用流程
  • 注册开放和集成接口
  • 示例

通用扩展点与平台SPI清单

• SPI 机制
  • Pamirs SPI 框架
  • 配置方式
• 系统扩展点
  • 框架层
  • 元数据扫描
  • 元数据计算
  • API 层
  • FaaS 层
  • ORM 层
  • 持久层

平台错误码（Error code）

• 平台内置错误码
• 业务错误码