检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何为对象自定义API 使用说明 当系统提供的基本操作无法满足需求时,可通过自定义API来实现 图1 查看操作类型 约束与限制 如果您的业务设置为聚合关系,则只能在主要方自定义API。 添加自定义API 在业务设计页面,选中某个业务对象。 单击BO属性操作中的“自定义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:
对象详解 BO Abstract BO Value Object 对象间关系 父主题: 后端应用管理
对象间关系 一对多 多对多 聚合 树递归 继承 父主题: 对象详解
public class CardApiController implements CardApi { ------ } 7、x-method-annotations 作用: 添加指定的注解。 该标签用于在api接口类中指定的api方法上添加注解。 标签值类型: List
vue:用于定义Vue组件,包括模板(HTML)、脚本(JavaScript)和样式(CSS)。 组件协议结构规范 组件协议结构规范用于描述组件的关键信息和配置项,对应组件的components字段。 表1 组件协议结构规范 字段 说明 类型 name 组件名称,以“i18n”形式配置。 Object
用户自定义鉴权使用 devspore提供鉴权插件接口,用户只需实现对应鉴权接口即可。 自定义鉴权插件 继承抽象类Processor,实现doProcess接口,可定义多个插件。 插件均需注册为bean。 import com.huawei.devspore.plugin.spi.authorization
至画布空白区域。 选中BO对象,在对象属性中,单击“自定义API”。 图3 自定义API 单击“新增”,添加一个自定义API。 图4 自定义一个API 在请求对象或返回对象的参数中,使用自定义DTO。 图5 在自定义API中使用自定义DTO 父主题: AstroPro学堂
首页”,即可进入AstroPro界面。 图2 AstroPro服务控制台 首次进入首页时,请勾选AstroPro隐私协议及服务声明,如图3所示。 图3 勾选隐私协议及服务声明 图4 AstroPro界面 父主题: 新手指引
被监控组件或应用名称。 devspore.probe.metrics.api-description-tags false boolean 是否开启http_server_request指标添加description标签功能,如开启,会自动添加@ApiOperation注解的value字段或@Oper
ct BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java
通过导入swagger文件实现业务设计 Swagger文件是一个用于描述RESTful API的规范,它可以用来导入设计业务,确保 API 的设计符合业务需求。 前提条件 根据业务模型,完成swagger文件设计,swagger标签使用可参考swagger标签使用指南 导入swagger文件
NESTED:是否设置DTO的NESTED(嵌套)能力。默认为生成DTO读写API。 不设置:不生成NESTED。 只生成DTO:只生成NESTED对象的类。 生成DTO读API:只会生成一个get接口。 生成DTO读写API:除了生成一个get接口,还会生成一个插入接口。 DTO暴露方式 - CARTESIAN
新手指引 入门必读 购买基础版实例 购买专业版实例 购买企业版实例 升级实例版本 登录AstroPro界面
执行框架转换 应用场景 针对企业中使用Dubbo等其他API框架的存量服务,AstroPro支持将代码统一转换为Spring MVC + OpenAPI的主流框架。转换后的框架将统一化,这有助于简化技术栈,降低技术多样性带来的复杂性,同时提高开发和运维团队的效率。 约束与限制 框架转换为Astro
" } } Web框架模型:生成基于spring-webmvc的API层。 关闭API中根对象前缀:设置为“是”时,sharding bo的API前面不需要添加root bo的路径。 注意:关闭API中根对象前缀为Astro Pro专业版/企业版功能,如果您需要使用此功能,请升级Astro
ract BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java
项目管理 新建项目 编辑项目 删除项目 父主题: 后端应用管理
角色管理 了解AstroPro中角色 为用户添加工作空间级角色 为用户添加项目级角色 父主题: 后端应用管理