检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。springdoc基本配置较为简单,如下所示: springdoc:
使用工具类方法 添加工具类 npm utils使用示例 function utils使用示例 父主题: 前端应用管理
在左侧插件栏中,单击,展开资源管理页面。 单击,进入添加工具类页面。 工具类型选择“function”。 输入工具类的名称,并编写函数代码。 图1 添加function工具类 单击“保存”,完成function工具类添加。 添加npm工具类 对于一些简单的公共函数来说,直接添加function工具类会很方便,但是对于
升级API版本 使用说明 服务创建后,若需要修改服务的API版本号,可通过新增版本实现。 图1 API版本号 API版本对应服务metadata.json文件中,Service段的apiVersion字段,一般为v1、v2类型的值。 图2 查看apiVersion取值 操作步骤
如何为对象自定义API 使用说明 当系统提供的基本操作无法满足需求时,可通过自定义API来实现 图1 查看操作类型 约束与限制 如果您的业务设置为聚合关系,则只能在主要方自定义API。 添加自定义API 在业务设计页面,选中某个业务对象。 单击右侧属性配置中的“自定义API”,进入编辑自定义API页面。
单击,进入添加工具类页面。 工具类型选择“function”。 输入工具类的名称,并编写函数代码。 function isNil(value) { return value == null } 图1 添加function工具类 单击“保存”,完成function工具类添加。 在JS面板的函数中使用function
)存储用户信息供后续业务代码使用。 TokenParser接口介绍详见:TokenParser接口介绍 UserInfo用户信息类介绍详见:UserInfo用户信息类 UserStore接口介绍详见:UserStore接口介绍 认证配置 认证配置详见:认证配置 配置说明 配置说明详见:配置说明
通过导入swagger文件实现业务设计 Swagger文件是一个用于描述RESTful API的规范,它可以用来导入设计业务,确保 API 的设计符合业务需求。 前提条件 根据业务模型,完成swagger文件设计,swagger标签使用可参考swagger标签使用指南 导入swagger文件
进行勾选。 框架配置 设置服务的架构、数据库、缓存和安全认证等信息,请根据实际业务直接在界面进行勾选。 生成策略 设置服务的API、代码风格、部署和性能测试等信息,请根据实际业务直接在界面进行勾选。 业务设计 基本配置、框架配置和生成策略需要用户根据自身业务的实际情况进行配置,配
运行于Web容器中。 性能测试。 注意:性能测试配置为Astro Pro专业版/企业版功能,如果您需要使用此功能,请升级Astro Pro实例版本。 图6 性能测试 CodeArts性能测试:是否使用CodeArts PerfTest进行性能测试。性能测试CodeArts Per
bind等。 服务在线文档生成工具:swagger(v2,v3),springdoc-openapi-ui(jdk8),springdoc-openapi-starter-webmvc-ui(jdk17),有了这些工具后可以为服务接口字段生成openapi在线文档。 yaml文件
在物料资产包中选择按钮组件,并拖拽至中心画布中。 添加npm utils 在左侧插件栏中,单击,展开资源管理页面。 单击,进入添加工具类页面。 工具类型选择“npm”。 参考表1配置工具类的参数。 表1 参数说明 参数 示例 名称 Loading 包名 @opentiny/vue 导出名称 Loading
配置连接器 应用场景 通过连接器生成客户端,可以将已有服务的接口抽象和封装为一套标准化的客户端库。这样,其他服务可以通过这些客户端库以统一和简化的方式调用已有服务的接口,无需关心服务的具体实现细节。生成的客户端库可以作为服务间通信的标准工具,减少了重复的代码编写,提高了开发效率和代码的可重用性。
初识应用设计器 AstroPro设计器可以分为顶部工具栏、左侧插件栏、中间画布区和右侧属性设置面板四个主要界面模块。 图1 AstroPRO设计器 顶部工具栏 设计器顶部的工具栏从左到右包括: :撤销上一步的操作。 :恢复上次撤销的内容。 :保存当前页面数据。 :发布页面模板。 :清空当前画布内容。
# API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java |-- service # 承接API直接调用,基本的业
配置说明 日志配置 使用swagger进行在线API文档配置 父主题: spring-boot-huawei使用指南
设计前端应用流程 前端开发视频指导 管理前端应用 页面管理 使用组件 配置属性设置 配置样式设置 配置高级设置 查看大纲树 数据源管理 使用工具类方法 国际化资源管理 使用JS面板 配置变量 生成业务代码 发布页面模板 使用模板创建页面 页面模板管理 物料中心
ct BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java
至画布空白区域。 选中BO对象,在对象属性中,单击“自定义API”。 图3 自定义API 单击“新增”,添加一个自定义API。 图4 自定义一个API 在请求对象或返回对象的参数中,使用自定义DTO。 图5 在自定义API中使用自定义DTO 父主题: AstroPro学堂
ract BO等。 com.astropro |-- api # API层代码,定义向外部服务暴露的接口(必填项) {biz}Api.java {biz}Controller.java