检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。springdoc基本配置较为简单,如下所示: springdoc:
> 前端应用”。 单击待编辑应用模块内的“开发应用”,进入设计器。 添加变量,例如:bgcolor,用来控制背景颜色;color,用来控制字体颜色,具体操作请参考添加页面变量。 图1 添加变量 画布中选中组件,在组件属性设置面板选择“样式”。 单击行内样式的编辑框后的。 在弹框中进行变量绑定。
选择页面类型:可选“静态页面”或“公共页面”。 页面名称:只允许包含英文字母,且以大写开头驼峰格式,如DemoPage。 选择文件夹:下拉框中选择文件夹名称。 路由:输入路由信息,只允许包含英文字母、数字、下划线、中划线和正斜杠组成, 且以英文字母开头。 单击“选择模板”,在右侧展开面板中选择模板。
设置服务的基本信息,单击“确定”。 图2 设置服务基本信息 服务名称:设置待添加服务的名称,生成的服务代码压缩包和解压后的文件会以此命名。服务名称由英文字母、数字或“-”组成,且必须以字母开头,一般采用驼峰格式,长度最低为两位。 图3 代码压缩包名称 服务类型:当前仅支持创建原子服务。原子
在应用服务列表中选择待操作的应用服务,单击“操作”列的“编辑”。 重新配置应用服务的基本信息。 应用服务名称:输入应用服务名称,名称仅允许以英文字母开头,包含英文字母和数字,一般采用驼峰格式或“-”连接,长度最低为两位。 描述:输入应用服务补充说明信息。 单击“确定”,完成应用服务编辑。 父主题:
选择项目和服务组,单击“新建服务”。 图2 新增一个服务 设置服务的基本信息。 图3 设置服务基本信息 服务名称:设置待添加服务的名称,由英文字母、数字或“-”组成,且必须以字母开头,一般采用驼峰格式,长度最低为两位。 服务类型:当前仅支持创建原子服务。原子服务是指对外提供业务对
bind等。 服务在线文档生成工具:swagger(v2,v3),springdoc-openapi-ui(jdk8),springdoc-openapi-starter-webmvc-ui(jdk17),有了这些工具后可以为服务接口字段生成openapi在线文档。 yaml文件
刷新当前页面数据,如果页面未保存,页面配置将恢复到上一次保存的状态。 :单击后可展开左侧插件栏的设置插件,设置当前页面属性。 :单击可进行画布中英文切换。 :多终端工具切换,可切换画布宽度。 :页面预览,打开新Tab预览当前页面。 下载源码:将当前页面数据转换并下载代码到本地。 左侧插件栏
粘性定位:组件在滚动时“粘”在某个位置,直到达到某个条件才会离开这个位置。粘性定位可以让页面在滚动时保持某些组件的可见性。 图4 设置定位 文本:设置文本的字号、字体、行高、字重、颜色、对齐方式、风格及修饰。 图5 设置文本 背景:设置组件背景,背景图、渐变类型、颜色及裁剪方式。 图6 设置背景 边框:
67564435为词条的key值,可参考复制词条键值获取。 图6 绑定变量 单击“确定”,变量绑定完成。 单击顶部工具栏的中英文切换按钮,可进行中英文切换。 图7 中文显示 图8 切换英语 父主题: 前端应用管理
选择项目和服务组,单击“新建服务”。 图1 新增一个服务 设置服务的基本信息。 图2 设置服务基本信息 服务名称:设置待添加服务的名称,由英文字母、数字或“-”组成,且必须以字母开头,一般采用驼峰格式,长度最低为两位。 服务类型:当前仅支持创建原子服务。原子服务是指对外提供业务对
选择页面类型:可选“静态页面”或“公共页面”。 页面名称:只允许包含英文字母,且以大写开头驼峰格式,如DemoPage。 选择文件夹:下拉框中选择文件夹名称。 路由:输入路由信息,只允许包含英文字母、数字、下划线、中划线和正斜杠组成, 且以英文字母开头。 图4 创建页面 单击“保存”。 在弹框中输入历史备份信息,单击“确定”。
在下拉框中,分别选择应用服务所属的项目、应用和子域,单击“新增应用服务”。 配置应用服务基本信息。 应用服务名称:输入应用服务名称,名称仅允许以英文字母开头,包含英文字母和数字,一般采用驼峰格式或“-”连接,长度最低为两位。 描述:输入应用服务补充说明信息。 图1 新建应用服务 单击“确定”,完成应用服务创建。
按钮组件:在右侧属性设置面板选择“样式”,设置尺寸宽为100%,高度为30px,字体颜色为白色,背景颜色为蓝色;在右侧属性设置面板选择“属性”,文本输入“登录”。 Text组件2:在右侧属性设置面板选择“样式”,设置字体颜色为蓝色,字号10px;在右侧属性设置面板选择“属性”,文本输入“设置/忘记密码”。
中角色。 在业务基础模板页面,单击“新建业务对象模板”。 配置模板信息后,单击“下一步”。 模板名称:输入模板名称,名称仅允许以英文字母开头,包含英文字母和数字,一般采用驼峰格式或“-”连接,长度最低为两位。 模板类型:默认为业务对象模板,暂不支持修改。 模板范围:根据3选择的项目,确认模板范围。
选择页面类型:可选“静态页面”或“公共页面”。 页面名称:只允许包含英文字母,且以大写开头驼峰格式,如DemoPage。 选择文件夹:下拉框中选择文件夹名称。 路由:输入路由信息,只允许包含英文字母、数字、下划线、中划线和正斜杠组成, 且以英文字母开头。 图3 创建页面 (可选)页面生命周期配置。
客户端流控策略 必选参数,由英文字母和数字及连字符(-)组成,且只能以英文字母开头,采用驼峰格式。例如,Custom。 长度范围为2~63位。 规则名称 可选参数,仅当勾选了重试、熔断或超时选项后为必填。 规则名称由英文字母和数字及连字符(-)组成,且只能以英文字母开头,采用驼峰格式。
配置说明 日志配置 使用swagger进行在线API文档配置 父主题: spring-boot-huawei使用指南
选择创建模板的项目 在架构模板页面,单击“新建架构模板”。 配置模板信息后,单击“下一步”。 模板名称:输入模板名称,名称仅允许以英文字母开头,包含英文字母和数字,一般采用驼峰格式或“-”连接,长度最低为两位。 模板类型:默认为架构模板,暂不支持修改。 模板范围:根据3选择的项目,确认模板范围。
一般一个分组对应一个研发团队。 图5 新增服务 设置服务的基本信息。 图6 新建Order服务 服务名称:设置待添加服务的名称。服务名称由英文字母、数字或“-”组成,且必须以字母开头,一般采用驼峰格式,长度最低为两位。 服务类型:当前仅支持创建原子服务。原子服务是指对外提供业务对