检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。springdoc基本配置较为简单,如下所示: springdoc: api-docs:
升级API版本 使用说明 服务创建后,若需要修改服务的API版本号,可通过新增版本实现。 图1 API版本号 API版本对应服务metadata.json文件中,Service段的apiVersion字段,一般为v1、v2类型的值。 图2 查看apiVersion取值 操作步骤
如何为对象自定义API 使用说明 当系统提供的基本操作无法满足需求时,可通过自定义API来实现 图1 查看操作类型 约束与限制 如果您的业务设置为聚合关系,则只能在主要方自定义API。 添加自定义API 在业务设计页面,选中某个业务对象。 单击BO属性操作中的“自定义API”,进入编辑自定义API页面。
spring-webmvc模块,处理常用格式json数据所需的jackson-databind等。 服务在线文档生成工具:swagger(v2,v3),springdoc-openapi-ui(jdk8),springdoc-openapi-starter-webmvc-ui(j
yaml或者application.properties中加入devspore-probe配置项。 下文中配置项的格式为yaml文件,如果配置文件为properties格式,需自行修改格式。 配置项的具体值含义参考配置说明 devspore-probe的配置样例: 1 2 3 4 5 devspore:
”列的“编辑”。 重新配置应用服务的基本信息。 应用服务名称:输入应用服务名称,名称仅允许以英文字母开头,包含英文字母和数字,一般采用驼峰格式或“-”连接,长度最低为两位。 描述:输入应用服务补充说明信息。 单击“确定”,完成应用服务编辑。 父主题: 应用服务管理
署,该服务只在一个单元(一般以region为单元)内部署。编辑服务时可修改单元化策略。 API版本:服务的API版本,默认为新增一个服务时配置的版本,如果需要升级API的版本,请参见升级API版本。 是否启用扩展拦截:通过引入devspore-horizon插件,用户自定义继承抽
public class CardApiController implements CardApi { ------ } 7、x-method-annotations 作用: 添加指定的注解。 该标签用于在api接口类中指定的api方法上添加注解。 标签值类型: List
域是否进行单元化部署,该服务只在一个单元(一般以region为单元)内部署。编辑服务时可修改单元化策略。 API版本:指定服务的API版本,对应服务Service段的apiVersion字段,一般为v1、v2类型的值。 描述:设置服务的描述信息。 单击“确定”,即可完成服务的创建。
创建服务 输入变更日志描述信息,单击“创建”。 系统开始创建服务,并生成该服务的基本代码。代码生成后,界面会提供一个压缩包,可直接下载使用。压缩包格式为“服务名称+唯一ID”。 图2 开始创建微服务 到此您已完成整个企业核心应用的创建。 打开生成的服务代码包,在“README.md”文件
# API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java |-- service # 承接API直接调用,基本的业
服务创建后,在步骤4:编辑服务中编辑元数据时,可进行修改。 API版本:指定服务的API版本,对应服务metadata.json文件中,Service段的apiVersion字段,一般为v1、v2类型的值。 图4 apiVersion 描述:设置服务的描述信息。 父主题: 创建企业核心应用
画布中选中组件,在组件属性设置面板选择“样式”。 单击全局样式的输入框,输入类名,例如.test。 类名不能以数字开头。 绑定组件属性元素ID:使用格式 #elementID。 绑定组件样式类:使用格式 .className。 图1 创建类名 单击回车键,类名创建完成。 父主题: 类名管理
单击“页面管理”的新增页面按钮。 设置页面基本属性。 选择页面类型:可选“静态页面”或“公共页面”。 页面名称:只允许包含英文字母,且以大写开头驼峰格式,如DemoPage。 选择文件夹:下拉框中选择文件夹名称。 路由:输入路由信息,只允许包含英文字母、数字、下划线、中划线和正斜杠组成, 且以英文字母开头。
换为对象。 设置代码风格。 图9 设置代码风格 配置文件格式:配置spring boot properties文件格式。 yaml :配置文件使用yaml格式。 properties :配置文件使用properties格式。 Lombok插件:是否为DO、DTO或QO定义类自动生成Lombok注解。
“UNIQUE”为唯一索引。 图2 新增字段 图3 添加索引 自定义API:当系统预置的增删改查操作不能满足需求时,您可以通过自定义API来实现某个操作。如何为对象自定义API,请参见如何为对象自定义API。 软删除策略:开启软删除策略后,数据删除时执行逻辑删除,数据仍然保留在
" } } Web框架模型:生成基于spring-webmvc的API层。 关闭API中根对象前缀:设置为“是”时,sharding bo的API前面不需要添加root bo的路径。 注意:关闭API中根对象前缀为Astro Pro专业版/企业版功能,如果您需要使用此功能,请升级Astro
新方法。 方法名称:输入方法名称,名称可以由字母、数字、下划线、$ 符号组成,不能以数字开头。 扩展参数:调用当前事件传入的真实参数,数组格式,追加在原有事件参数之后如: onClickNew(eventArgs, extParam1, extParam2, ...)。 图1 设置绑定事件
ract BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java
至画布空白区域。 选中BO对象,在对象属性中,单击“自定义API”。 图3 自定义API 单击“新增”,添加一个自定义API。 图4 自定义一个API 在请求对象或返回对象的参数中,使用自定义DTO。 图5 在自定义API中使用自定义DTO 父主题: AstroPro学堂