检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。
在左侧导航栏中,选择“后端开发平台 > 服务管理 > 服务”。 在服务列表中,单击对应服务后的“更多 > 复制服务”。 复制成功后,自动进入服务编辑页面,您可以直接使用服务,也可以进行二次开发。 图2 选择复制服务 父主题: 服务管理
系统开始创建服务,并生成该服务的代码。 图1 创建服务并生成代码包 父主题: 服务管理
编辑服务 步骤1:基本配置 步骤2:框架配置 步骤3:生成策略 步骤4:业务设计 步骤5:服务依赖 父主题: 服务管理
配置说明 日志配置 使用swagger进行在线API文档配置 父主题: spring-boot-huawei使用指南
详细配置 图4 详细配置 服务类型:当前仅支持创建原子服务。原子服务是指对外提供业务对象管理API,有独立数据存储(一般为独立数据库)的服务。原子服务之间可以相互调用。 服务组:选择服务所属的分组。如何创建服务组,请参见新建服务组。 服务单元化策略:服务在子域内的单元化策略。
应用服务名称:输入应用服务名称,名称仅允许以英文字母开头,包含英文字母和数字,一般采用驼峰格式或“-”连接,长度最低为两位。 描述:输入应用服务补充说明信息。 单击“确定”,完成应用服务编辑。 父主题: 应用服务管理
编辑服务组 使用说明 服务组创建后,支持再次修改服务组的名称和描述。 操作步骤 参考登录AstroPro界面中操作,登录AstroPro界面。 在左侧导航栏中,选择“后端开发平台 > 服务管理 > 服务组”。 选择服务组所属的项目,单击已创建服务组后的“编辑”。
建议和接器名称保持一致。 版本 设置连接器的版本号,默认值为0.0.1-SNAPSHOT,可自定义。 只能包含大小写字母、数字、连字符(-)、下划线(_)和点号(.)。
图1 包年/包月AstroPro套餐生命周期 到期预警 AstroPro套餐在包年/包月的到期前第7天内,系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为账号的创建者。
当创建子域是开启单元化配置,则关联Rooted服务。当创建子域是关闭单元化配置,则关联Single服务。 图1 关联Single服务 图2 关联Rooted服务 单击“确定”,完成服务关联。 关联成功后,服务信息会同步到应用服务中,可在应用服务列表中查看。
在服务列表中,单击已创建服务后的“更多 > 重新生成”,即可重新生成服务的代码。 图1 重新生成服务代码 单击操作中的“详情”,在服务详情页,同样可以对服务进行重新生成。 图2 在详情页重新编译服务 图3 重新生成代码并下载 父主题: 服务管理
删除服务 使用说明 当服务不再使用时,可删除已创建的服务。若服务存在依赖服务,请先删除依赖关系,再删除该服务。如何删除服务依赖,请参见删除服务依赖。 约束与限制 服务删除后不可恢复,请谨慎操作。 单个删除服务 参考登录AstroPro界面中操作,登录AstroPro界面。
删除服务组 使用说明 服务组不再使用时,可以删除已创建的服务组。删除服务组前,请确保服务组中的服务已删除。如何删除服务,请参见删除服务。 单个删除服务组 参考登录AstroPro界面中操作,登录AstroPro界面。 在左侧导航栏中,选择“服务管理 > 服务组”。
#日志配置 logging: charset: file: UTF-8 console: UTF-8 file: name: /opt/cloud/log/{服务名}/{服务名}.log #日志文件的位置及名称 pattern: file
图5 设置对象间关系 设置完成后,单击“下一步”,进行服务依赖设置。 父主题: 编辑服务
服务在线文档生成工具:swagger(v2,v3),springdoc-openapi-ui(jdk8),springdoc-openapi-starter-webmvc-ui(jdk17),有了这些工具后可以为服务接口字段生成openapi在线文档。
步骤5:服务依赖 通常情况下,一个应用不是一个单独的服务,可能由多个服务共同组成。这些服务之间可能存在一些跨服务的调用,此时就需要通过添加依赖服务,把这些服务的客户端集成过来。添加依赖服务前,请确保依赖服务的“是否生成客户端”按钮已启用。
删除服务依赖 使用说明 需要解除服务之间的依赖时,可以通过删除服务依赖来实现。 单个删除服务依赖 参考登录AstroPro界面中操作,登录AstroPro界面。 在左侧导航栏中,选择“后端开发平台 > 服务管理 > 服务依赖”。
在依赖服务列表中,单击服务后的“查看”,即可查看服务间的依赖。 父主题: 服务依赖管理