检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
升级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:
如何为对象自定义API 使用说明 当系统提供的基本操作无法满足需求时,可通过自定义API来实现 图1 查看操作类型 约束与限制 如果您的业务设置为聚合关系,则只能在主要方自定义API。 添加自定义API 在业务设计页面,选中某个业务对象。 单击BO属性操作中的“自定义API”,进入编辑自定义API页面。
public class CardApiController implements CardApi { ------ } 7、x-method-annotations 作用: 添加指定的注解。 该标签用于在api接口类中指定的api方法上添加注解。 标签值类型: List
通过导入swagger文件实现业务设计 Swagger文件是一个用于描述RESTful API的规范,它可以用来导入设计业务,确保 API 的设计符合业务需求。 前提条件 根据业务模型,完成swagger文件设计,swagger标签使用可参考swagger标签使用指南 导入swagger文件
域是否进行单元化部署,该服务只在一个单元(一般以region为单元)内部署。编辑服务时可修改单元化策略。 API版本:指定服务的API版本,对应服务Service段的apiVersion字段,一般为v1、v2类型的值。 描述:设置服务的描述信息。 单击“确定”,即可完成服务的创建。
服务创建后,在步骤4:编辑服务中编辑元数据时,可进行修改。 API版本:指定服务的API版本,对应服务metadata.json文件中,Service段的apiVersion字段,一般为v1、v2类型的值。 图4 apiVersion 描述:设置服务的描述信息。 父主题: 创建企业核心应用
ract BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java
了解服务创建流程 什么是(微)服务 (微)服务是业务概念,即提供某种服务的某个进程。每一个服务都具有自主运行的业务功能,对外开放不受语言限制的API,多个(微)服务组成应用程序。 AstroPro是一个企业应用一站式构建平台,对于平台来说不需要过多的区分服务和微服务。 了解服务创建流程
ct BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java
“UNIQUE”为唯一索引。 图2 新增字段 图3 添加索引 自定义API:当系统预置的增删改查操作不能满足需求时,您可以通过自定义API来实现某个操作。如何为对象自定义API,请参见如何为对象自定义API。 软删除策略:开启软删除策略后,数据删除时执行逻辑删除,数据仍然保留在
springdoc:springdoc-openapi-ui jdk8版本存在 org.springdoc:springdoc-openapi-starter-webmvc-ui jdk17版本存在 org.springdoc:springdoc-openapi-starter-webflux-ui
" } } Web框架模型:生成基于spring-webmvc的API层。 关闭API中根对象前缀:设置为“是”时,sharding bo的API前面不需要添加root bo的路径。 注意:关闭API中根对象前缀为Astro Pro专业版/企业版功能,如果您需要使用此功能,请升级Astro
表,其它sharding表外键引用它的方式。也可以直接为每个表加一个根维度表id字段。 API版本:服务的API版本,默认为新增一个服务时配置的版本,如果需要升级API的版本,请参见升级API版本。 是否启用扩展拦截:通过引入devspore-horizon插件,用户自定义继承抽
NESTED:是否设置DTO的NESTED(嵌套)能力。默认为生成DTO读写API。 不设置:不生成NESTED。 只生成DTO:只生成NESTED对象的类。 生成DTO读API:只会生成一个get接口。 生成DTO读写API:除了生成一个get接口,还会生成一个插入接口。 DTO暴露方式 - CARTESIAN
署,该服务只在一个单元(一般以region为单元)内部署。编辑服务时可修改单元化策略。 API版本:服务的API版本,默认为新增一个服务时配置的版本,如果需要升级API的版本,请参见升级API版本。 是否启用扩展拦截:通过引入devspore-horizon插件,用户自定义继承抽
解析成功后调用setUserInfo(UserInfo userInfo)接口存储用户信息。 后续业务接口鉴权或业务逻辑需要时调用getUserInfo()接口获取当前用户信息。 实现UserStore接口 import com.huawei.devspore.plugin.spi
至画布空白区域。 选中BO对象,在对象属性中,单击“自定义API”。 图3 自定义API 单击“新增”,添加一个自定义API。 图4 自定义一个API 在请求对象或返回对象的参数中,使用自定义DTO。 图5 在自定义API中使用自定义DTO 父主题: AstroPro学堂
执行框架转换 应用场景 针对企业中使用Dubbo等其他API框架的存量服务,AstroPro支持将代码统一转换为Spring MVC + OpenAPI的主流框架。转换后的框架将统一化,这有助于简化技术栈,降低技术多样性带来的复杂性,同时提高开发和运维团队的效率。 约束与限制 框架转换为Astro
开启自定义鉴权功能 自定义鉴权功能在微服务架构、API管理、企业内部系统集成等方面发挥着重要作用,它提供了灵活性和可扩展性,以满足不同业务场景下的安全需求。 开启自定义鉴权功能前,请确保依赖服务的“是否启用扩展拦截”按钮已启用。 图1 开启“是否启用扩展拦截”配置 登录Astro