检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何为对象自定义API 使用说明 当系统提供的基本操作无法满足需求时,可通过自定义API来实现 图1 查看操作类型 约束与限制 如果您的业务设置为聚合关系,则只能在主要方自定义API。 添加自定义API 在业务设计页面,选中某个业务对象。 单击右侧属性配置中的“自定义API”,进入编辑自定义API页面。
升级API版本 使用说明 服务创建后,若需要修改服务的API版本号,可通过新增版本实现。 图1 API版本号 API版本对应服务metadata.json文件中,Service段的apiVersion字段,一般为v1、v2类型的值。 图2 查看apiVersion取值 操作步骤
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。springdoc基本配置较为简单,如下所示: springdoc: api-docs:
用户自定义鉴权使用 devspore提供鉴权插件接口,用户只需实现对应鉴权接口即可。 自定义鉴权插件 继承抽象类Processor,实现doProcess接口,可定义多个插件。 插件均需注册为bean。 import com.huawei.devspore.plugin.spi.authorization
不设置:不生成NESTED。 只生成DTO:只生成NESTED对象的类。 生成DTO读API:只会生成一个get接口。 生成DTO读写API:除了生成一个get接口,还会生成一个插入接口。 DTO暴露方式 - CARTESIAN:设置DTO的CARTESIAN(笛卡尔积)能力。
# API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java |-- service # 承接API直接调用,基本的业
public class CardApiController implements CardApi { ------ } 7、x-method-annotations 作用: 添加指定的注解。 该标签用于在api接口类中指定的api方法上添加注解。 标签值类型: List
不设置:不生成NESTED。 只生成DTO:只生成NESTED对象的类。 生成DTO读API:只会生成一个get接口。 生成DTO读写API:除了生成一个get接口,还会生成一个插入接口。 DTO暴露方式 - CARTESIAN:设置DTO的CARTESIAN(笛卡尔积)能力。
解析成功后调用setUserInfo(UserInfo userInfo)接口存储用户信息。 后续业务接口鉴权或业务逻辑需要时调用getUserInfo()接口获取当前用户信息。 实现UserStore接口 import com.huawei.devspore.plugin.spi
NESTED:是否设置DTO的NESTED(嵌套)能力。默认为生成DTO读写API。 不设置:不生成NESTED。 只生成DTO:只生成NESTED对象的类。 生成DTO读API:只会生成一个get接口。 生成DTO读写API:除了生成一个get接口,还会生成一个插入接口。 DTO暴露方式 - CARTESIAN
)存储用户信息供后续业务代码使用。 TokenParser接口介绍详见:TokenParser接口介绍 UserInfo用户信息类介绍详见:UserInfo用户信息类 UserStore接口介绍详见:UserStore接口介绍 认证配置 认证配置详见:认证配置 配置说明 配置说明详见:配置说明
获取数据源远程字段 使用说明 您可以通过已有的远程Http接口,快速地生成数据源的字段。 操作步骤 参考登录AstroPro界面中操作,登录AstroPro界面。 在左侧导航栏中,选择“前端开发平台 > 前端应用”。 单击应用模块内的“开发应用”,进入设计器。 在左侧插件栏中,单击,展开数据源管理页面。
配置连接器 应用场景 通过连接器生成客户端,可以将已有服务的接口抽象和封装为一套标准化的客户端库。这样,其他服务可以通过这些客户端库以统一和简化的方式调用已有服务的接口,无需关心服务的具体实现细节。生成的客户端库可以作为服务间通信的标准工具,减少了重复的代码编写,提高了开发效率和代码的可重用性。
horizon: processors: customRequestPlugin Exit插件 实现Observer接口中observer接口,可定义多个插件。 插件均需注册为bean。 import com.huawei.devspore.horizon.DataEvent;
至画布空白区域。 选中BO对象,在对象属性中,单击“自定义API”。 图3 自定义API 单击“新增”,添加一个自定义API。 图4 自定义一个API 在请求对象或返回对象的参数中,使用自定义DTO。 图5 在自定义API中使用自定义DTO 父主题: AstroPro学堂
processors: bean1,bean2 出口插件 实现exit插件。 devspore-horizon提供了接口Observer,用户需要实现这个接口的observe(DataEvent dataEvent)方法,把变更通知、更新缓存、统一审计、统一工作流的处理逻辑写到此方法体内即可。
ct BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java
被监控组件或应用名称。 devspore.probe.metrics.api-description-tags false boolean 是否开启http_server_request指标添加description标签功能,如开启,会自动添加@ApiOperation注解的value字段或@Oper
执行框架转换 应用场景 针对企业中使用Dubbo等其他API框架的存量服务,AstroPro支持将代码统一转换为Spring MVC + OpenAPI的主流框架。转换后的框架将统一化,这有助于简化技术栈,降低技术多样性带来的复杂性,同时提高开发和运维团队的效率。 约束与限制 框架转换为Astro
ract BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java