相关推荐

• 产品使用手册

  使用GraphQL生成API文档

  GraphiQL 是一个非常流行的交互式开发环境（IDE），专门用于浏览、编写和测试 GraphQL 查询。它不仅可以帮助你查询 API，还可以自动生成文档。以下是如何使用 GraphiQL 的具体步骤： 仓库地址：https://github.com/anvilco/spectaql?tab=readme-ov-file#yaml-options 一、使用GraphiQL 工具生成API文档。 1. GraphiQL 安装与配置 方式 ： 本地或全局安装 GraphiQL 如果你的 GraphQL API 服务器没有内置 GraphiQL，你可以使用独立的 GraphiQL 框架或包。 全局安装 GraphiQL如果你想在本地环境使用 GraphiQL，你可以通过 npm 或 yarn 安装：如果下载不成功可以使用淘宝镜像源 npm install -g graphiql 通过 npm 或 Yarn 安装为开发依赖你也可以将 GraphiQL 作为开发依赖安装到项目中： npm install graphiql 生成您的文档！ npx spectaql config.yml 运行此命令你需要一份config.yml文件。具体使用参考https://github.com/anvilco/spectaql?tab=readme-ov-file#yaml-options 2. 使用JSON格式生成文档 生成或导出 schema 文件 自动生成 schema如果你使用的是 Java 类和注解方式定义的 GraphQL API（使用 @GraphQLQuery 等注解），GraphQL schema 通常在运行时生成。你可以使用 Spring Boot 启动后访问 GraphQL endpoint 来手动导出 schema。 访问 GraphQL Endpoint：在应用运行时，GraphQL API 通常暴露在 /graphql 路径下。你可以通过 introspection 查询导出完整的 GraphQL schema；也可以使用/${module}路径导出指定模块接口。 下面是一个 introspection 查询的示例，它可以帮助你获取 schema：这个查询可根据文档需要动态调整。查询http://127.0.0.1:8091/pamirs/graphql，注意保证工程yml配置文件pamirs.framework.gateway.show-doc: true为开启状态。 query IntrospectionQuery { __schema { queryType { …FullType } mutationType { …FullType } subscriptionType { name } types { …FullType } directives { name description locations args { …InputValue } } } } fragment FullType on __Type { kind name description fields(includeDeprecated: true) { name description args { …InputValue } type { …TypeRef } isDeprecated deprecationReason } inputFields { …InputValue } interfaces { …TypeRef } enumValues(includeDeprecated: true) { name description isDeprecated deprecationReason } possibleTypes { …TypeRef } } fragment InputValue on __InputValue { name description type { …TypeRef } defaultValue } fragment…

  yexiu

  2024年9月13日

  1.8K000
• Oinone 7天入门到精通

  组件属性

  1. 通用属性 介绍组件和其属性之前，先介绍一些大部分组件通用支持的一些基础属性。 1.2 标题 标题是字段在当前页面的展示名称，标题默认为字段名称，可以修改。 1.2 占位提示 在未填写内容时，输入框或选择框内的浅色提示文字，仅用于提示，不会影响字段的值。 1.3 描述说明 一个字段的描述信息，通常用于说明当前字段的范围、注意事项等。描述说明大部分在组件的下方显示，特殊的是，分组的描述说明在标题的左侧。 1.4 默认值 创建数据时，有些字段大概率都是相同值，可设置默认值，减少添加人员的操作步骤，提高录入数据效率。 1.5 只读 设为只读时，字段可见，但不可编辑。 除了只读和非只读的对立选项，也可以设置条件只读，在设置的条件下才只读，条件不符合则非只读。 1.6 禁用 设为禁用时，字段可见，但不可编辑。 除了禁用和非禁用的对立选项，也可以设置条件禁用，在设置的条件下才禁用，条件不符合则非禁用。 1.7 隐藏 设为隐藏时，字段不可见，也不可编辑。但是在页面设计时，隐藏的组件也会展示，效果如下图。 除了隐藏和非隐藏的对立选项，也可以设置条件隐藏，在设置的条件下才隐藏，条件不符合则非隐藏。 1.8 必填 控制字段在当前页面是否必填，若设置为必填则在标题前会有红色的*作为标识。除了必填和非必填的对立选项，也可以设置条件必填，在设置的条件下才必填，条件不符合则非必填。 1.9 标题排列方式 字段的标题可以自定义横向排列还是纵向排列。每个字段组件都支持设置，设置后之间互不影响。除了组件支持自定义，表单、分组、选项卡也可以设置排列方式，对于这种布局容器类组件，设置后会将其容器内的所有组件的标题排列方式都改为所设置的值。 1.10 宽度 定义在页面中的宽度：占整行的比例，一般可选项有1/4、1/3、1/2、2/3、3/4、1。 其中1/2表示占当前行的一半；1表示占当前行一整行；以此类推。部分组件特殊，如富文本仅支持宽度为1，即占一整行。 2. 分组 分组是一个布局类组件，类似一个容器，可以把业务含义相近的内容放在这个分组容器内。 2.1 属性 2.1.1 标题 分组可以定义一个标题名称，标题显示在分组左上角，可以不设置标题。 2.1.2 描述说明 分组的描述说明显示在分组标题右侧。 2.1.3 标题排列方式 分组中的标题排列方式属性并不是控制分组的标题，而是控制分组内组件的标题。设置后对分组内的所有组件生效。 3. 选项卡 选项卡是一个布局类组件，类似一个容器，每个选项卡可以添加多个选项页，可以把业务含义相近的内容放在选项卡的选项页容器内。 3.1 选项卡属性 3.1.1 选项页排列方式 选中选项卡，可选择选项卡中的选项页排列方式：水平排列、竖直排列。默认是水平排列，效果如下图。 3.1.2 标题排列方式 选项卡中的标题排列方式控制选项卡内组件的标题。设置后对选项卡内的所有组件生效。 3.2 选项页属性 3.2.1 标题 选中选项页，显示选项页的属性设置，选项卡中的每个选项页支持设置标题。 3.2.2 标题排列方式 选项页中的标题排列方式控制选项页内组件的标题。设置后对选项页内的所有组件生效。同一个选项卡，不同选项页之间的标题排列方式可以不同。 4. 单行文本 单行文本输入框，常用于记录名称、身份证号或其他普通的文字内容。 4.1 创建字段 单行文本仅支持创建「文本」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 4.2 表单属性 4.2.1 通用属性 在表单中，单行文本可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 4.2.2 文本类型 文本类型选项为文本或密码。若设置为文本，输入时内容是可见的；若设置为密码，输入时是不可见的密码形态，如下图： 4.2.3 最小/大长度 设置输入框输入内容的长度，输入框会根据设置的值进行校验。 最大长度默认为创建字段时填写的长度，且设置的最大长度不可以大于字段的长度 最小长度默认为空，为空则为不限制最小长度 4.2.4 输入格式 设置输入格式为网址或者身份证时，会进行格式的校验 无：默认为无，不会校验内容 网址：进行网址校验 身份证：进行身份证号校验，设置后，需要输入正确的身份证号 4.2.5 显示计数器 当需要用户关注输入内容长度时，可以开启显示计数器，在输入时会实时显示当前内容的长度。 4.2.6 显示清除按钮 若开启了清除按钮，则在输入框有内容时，点击清除按钮一键清除已有内容 5. 多行文本 多行文本输入框，常用于记录字数较多的文字，如意见、复杂备注等。 5.1 创建字段 多行文本仅支持创建「多行文本」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 5.2 表单属性 5.2.1 通用属性 在表单中，单行文本可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 5.2.2 最小/大长度 设置输入框输入内容的长度，输入框会根据设置的值进行校验。 -最大长度默认为创建字段时填写的长度，且设置的最大长度不可以大于字段的长度 -最小长度默认为空，为空则为不限制最小长度 5.2.3 显示计数器 当需要用户关注输入内容长度时，可以开启显示计数器，在输入时会实时显示当前内容的长度。 5.2.5 显示清除按钮 若开启了清除按钮，则在输入框有内容时，点击清除按钮一键清除已有内容 6. 整数 整数输入框，常用于输入整数的天数、数量等，如果会出现小数，请使用小数组件。 6.1 创建字段 整数仅支持创建「整数」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 6.2 表单属性 6.2.1 通用属性 在表单中，整数可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 6.2.2 最小/大值 设置整数输入框输入内容的最值，输入框会根据设置的最值进行校验。 最大值可设置的范围根据字段填写的长度转换，如设置长度为3，则最大值最大不可以超过999 截图 6.2.3 显示千分位 数字过长时，不便于查看，可开启显示千分位。 7. 小数 小数输入框，常用于输入金额、单价等，会出现小数的数值。 7.1 创建字段 小数仅支持创建「浮点型」业务类型的字段，填写规则、内容和模型设计器端创建字段一致。 7.2 表单属性 7.2.1 通用属性 在表单中，小数可以设置一些通用的属性：标题、占位提示、描述说明、默认值、只读、隐藏、禁用、必填、标题排列方式、宽度。 7.2.2 最小/大值 设置小数输入框输入内容的最值，输入框会根据设置的最值进行校验。 最大值可设置的范围根据字段填写的长度转换，如设置长度为3，则最大值最大不可以超过999 7.2.3 保留小数位数 支持设置小数的保留位数，设置后在页面中输入内容时，将进行校验 可设置的保留小数位数不可大于该字段的精度，如字段精度为2，则组件属性中的小数位数最大只能为2； 7.2.4 显示千分位 数字过长时，不便于查看，可开启显示千分位。 8. 下拉单选 从多个选项中下拉选择一个数据，作为数据值。选项可以是关联模型的数据，也可以是数据字典或布尔型开关。 8.1 创建字段 下拉单选支持创建三种业务类型的字段，分别是：多对一、布尔型、数据字典。 多对一：创建字段时需要选择关联的模型，关联模型的数据将作为下拉选项； 布尔型：下拉选项默认只有是、否； 数据字典：创建字段时需要选择数据字典，其数据字典项将作为下拉选项 8.2 表单属性 8.2.1 通用属性 在表单中，下拉单选可以设置一些通用的属性：标题、占位提示、描述说明、只读、隐藏、禁用、必填、标题排列方式、宽度。 8.2.2 选项类型…

  史, 昂

  2024年6月20日

  1.6K000
• Oinone 7天入门到精通

  流程设计

  1.流程设计 进入流程设计页之后可以进行流程名称、流程说明的编辑，可以进行流程设计，流程参数配置，保存和发布。 1.1 流程配置 点击进入流程配置页面，若需要配置一些参数供流程使用，可在此添加和删除。删除流程参数时，若该参数已在流程中被使用则无法删除。参数支持文本、数值、日期、布尔四种类型。 1.2 保存 点击后流程设计进行存档，流程设计不完整也支持保存，下次进入流程设计回到保存的页面。 1.3 发布 第一次发布时右上角发布显示文字为发布流程，后续发布按钮显示文字为更新发布。发布后流程才会按照设计触发，首次发布和更新发布的逻辑一致，若流程中有未解决的错误则无法发布不成功，发布成功后页面跳转到显示全部流程的页面，流程状态为已启用、已更新。

  史, 昂

  2024年6月20日

  1.5K000
• Oinone 7天入门到精通

  6.2 集成平台（改）

  企业在数字化转型过程中内外部集成是一个必然需求、也是趋势 集成的诉求主要来自两个方面：1.企业的数字化改造是由外而内逐步进行的（内部异构集成）、2.企业数字化方向是朝越来越开放的方向发展（外部平台、工具集成）。总的来说企业在数字化转型过程中内外部集成是一个必然需求、也是趋势。所以我们不能简单地去理解做个API对接就结束了，而是要统一规划构建成企业的集成门户对API定义，安全、控制、记录等做全方位管理。oinone在下个版本规则中也纳入了基于集成平台之上做产品化配置的需求 概述 pamirs-eip为平台提供企业集成门户的相关功能，如请求外部接口使用的【集成接口】和对外开放被其他系统请求调用的【开放接口】功能。在请求外部接口时，还支持了多个接口调用（路由定义）、分页控制（paging）、增量控制（incremental）等功能。 准备工作 Step1 POM与模块依赖 pamirs-demo-api 和 pamirs-second-api 的pom文件中引入pamirs-eip2-api包依赖 <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-eip2-api</artifactId> </dependency> DemoModule和SecondModule 增加对EipModule的依赖 @Module(dependencies = {EipModule.MODULE_MODULE}) pamirs-demo-boot和pamirs-second-boot工程的pom文件中引入pamirs-eip2-core包依赖 <dependency> <groupId>pro.shushi.pamirs.core</groupId> <artifactId>pamirs-eip2-core</artifactId> </dependency> Step2 yaml配置文件参考 pamirs-demo-boot和pamirs-second-boot工程的application-dev.yml文件中增加配置pamirs.boot.modules增加eip，即在启动模块中增加eip模块 pamirs: boot: modules: – eip pamirs-demo-boot和pamirs-second-boot工程的application-dev.yml文件中增加eip模块的数据源与路由配置 pamirs: framework: data: ds-map: eip: eip datasource: eip: driverClassName: com.mysql.cj.jdbc.Driver type: com.alibaba.druid.pool.DruidDataSource url: jdbc:mysql://127.0.0.1:3306/eip_v3?useSSL=false&allowPublicKeyRetrieval=true&useServerPrepStmts=true&cachePrepStmts=true&useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&autoReconnect=true&allowMultiQueries=true username: root password: oinone initialSize: 5 maxActive: 200 minIdle: 5 maxWait: 60000 timeBetweenEvictionRunsMillis: 60000 testWhileIdle: true testOnBorrow: false testOnReturn: false poolPreparedStatements: true asyncInit: true pamirs-demo-boot工程的application-dev.yml文件中修改eip的配置 pamirs: eip: open-api: enabled: false pamirs-second-boot工程的application-dev.yml文件中修改eip的配置 pamirs: eip: enabled: true open-api: enabled: true route: host: 127.0.0.1 port: 8094 aes-key: Nj5Thnxz4rV8Yy1FLGA2hUym3RepB8MKgafEaYC4GKo= 注： hosts配置在远程调用时不能使用127.0.0.1，可配置为0.0.0.0进行自动识别。若自动识别仍无法访问，请准确配置其他已知的可访问IP地址。 aes-key：用下面代码生成 附录：AES Key生成 pro.shushi.pamirs.core.common.EncryptHelper加解密帮助类，默认支持AES、RSA类型的数据加解密方法，也可自定义其他类型的加解密方法。 System.out.println(EncryptHelper.getKey(EncryptHelper.getAESKey())); Step3 在pamirs-second-api新建一个SessionTenantApi实现类 只要在我们公共的jar包中构建类似DemoSessionTenant类就可以了，之所以要构建SessionTenantApi实现类是因为EIP是以租户信息做路由的。所以这里我们写死返回一个“pamirs”租户就好了。 记得要重新mvn install second工程，再刷新demo工程 package pro.shushi.pamirs.second.api.tenant; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; import pro.shushi.pamirs.framework.session.tenant.api.SessionTenantApi; import pro.shushi.pamirs.meta.api.core.session.SessionClearApi; import pro.shushi.pamirs.meta.common.spi.SPI; @Order(99) @Component @SPI.Service public class DemoSessionTenant implements SessionTenantApi, SessionClearApi { public String getTenant() { return "pamirs"; } public void setTenant(String tenant) { } public void clear() { } } 开放接口（举例） Step1 用于演示的模型定义 package pro.shushi.pamirs.second.api.model; import pro.shushi.pamirs.meta.annotation.Field; import pro.shushi.pamirs.meta.annotation.Model; import pro.shushi.pamirs.meta.base.IdModel; @Model.model(TestOpenApiModel.MODEL_MODEL) @Model(displayName = "演示开放接口模型") public class TestOpenApiModel extends IdModel { public static final String MODEL_MODEL = "demo.second.TestOpenApiModel"; @Field.String @Field(displayName = "名称") private…

  史, 昂

  2024年5月23日

  1.9K000
• Oinone 7天入门到精通

  5.6 商业支撑之商品域

  一、基础介绍 当业务在线化后，用于内部管理的产品主数据，叠加一堆销售属性变成了商品被推倒了前台，成为导购链路中最最重要的信息载体。看似最基础和最简单的商品模块也有很多门道。主要集中在以下几个方面： 商品的属性如何管理、呈现、参与导购（类目、搜索的过滤条件） 如何解决固定不变的内部管理需求与基于销售特性长期变化的运营需求之间的矛盾 在多渠道情况渠道商品，如何映射到实际sku进行履约 二、模型介绍 图5-6-1 模型介绍 类目属性，解决“商品的属性如何管理、呈现、参与导购（类目、搜索的过滤条件）” 前后台类目设计，解决“如何解决固定不变的内部管理需求与基于销售特性长期变化的运营需求之间的矛盾” 销售Sku和库存Sku设计，解决“在多渠道情况渠道商品，如何映射到实际sku进行履约” 要把这些问题搞清楚，得先把名词统一下： 领域 名称 oinone的定义 说明 举例 平台运营视角 Spu Product –>Spu2.1.9 –> 3.0.0 SPU(Standard Product Unit)：标准化产品单元。SPU是商品信息聚合的最小单位，是一组可复用、易检索的标准化信息的集合，该集合描述了一个产品的特性 iPhone X可以确定一个产品 后台类目 后台类目(Category) 商品分类分级管理，以及规范该类目下公共属性可以分为普通属性、销售属性 比如类目：3c数码/手机销售属性：内存大小、颜色等普通属性：分辨率 前台类目 前台类目(FrontCategory) 平台导购类目 通过前台类目关联后台类目或后台类目属性，用于满足运营需求 大体上SPU处于最上层、Item属于下一级，而SKU属于最低一层。SPU是平台层面，Item是商家层面，SKU是商家的Item确定销售属性SPU非必须，在平台类交易中，平台方为了规范商家发布商品信息，进行统一运营时需要 商家销售视角 Item 渠道商品(Item) 简单来说是：SPU加上归属商家、以及商家自有的价格与描述 商家A的iPhone X Sku 销售Sku(SaleSku) SKU=Stock Keeping Unit（库存保有单位）。是对每一个产品和服务的唯一标示符，该系统的使用SKU的值根于数据管理，使公司能够跟踪系统，如仓库和零售商店或产品的库存情况。 iPhone X 64G 银色 则是一个SKU。 店铺类目 ShopCategory 商家店铺导购类目 在平台类电商，商家都会有自己独立的店铺主页，商家类目跟前台类目作用类似，只是局限影响范围为商家店铺内 销售SKU中会有一个InvSkuCode来关联InventorySku，比如：品牌上在不同渠道（淘宝、京东、自建电商）中会有不同的销售SKU，在从渠道同步销售SKU会根据外部code 商家管理视角 产品或库存Sku InventorySku 跟销售领域的sku的定义类似，但销售领域是为了规范购买行为，这里规范企业内部管理。 iPhone X 64G 银色 组合Sku InventorySkuComposition 空调有内外机组合而成，这就是一个组合sku 产品分类 ProductKind 企业内部管理划分 商品系列 ItemSeries 指互相关联或相似的产品，是按照一定的分类标准对企业生产经营的全部产品进行划分的结果。一个产品系列内往往包括多个产品项目。产品系列的划分标准有产品功能、消费上的连带性、面向的顾客群、分销渠道、价格范围等 存货类别 StorageKind 为了反映存货的组成内容，正确计算产品的生产成本以及销售成本，会计上必须对存货进行科学地分类，按存货的不同类别进行核算 表5-6-1 各领域名称说明

  史, 昂

  2024年5月23日

  2.1K000