检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。
表1 创建子域参数说明 参数 说明 子域名称 输入子域名称,名称只能包含大小写字母、数字、连字符(-)和下划线(_)。 名称必须唯一,不能重复。 描述 设置子域的描述信息,只包含数字、大小写字母、汉字、空格和常用符号(‘’:?。,!;()'?:.,!;()-_@)的字符串。
表1 编辑子域参数说明 参数 说明 子域名称 输入子域名称,名称只能包含大小写字母、数字、连字符(-)和下划线(_)。 名称必须唯一,不能重复。 描述 设置子域的描述信息,只包含数字、大小写字母、汉字、空格和常用符号(‘’:?。,!;()'?:.,!;()-_@)的字符串。
实际应用中请换成自己对应的域名。
devspore-auth-starter</artifactId> <version>${devspore-auth-starter.version}</version> </dependency> TokenParser实现类与UserStore实现类,均需注册成bean,并完成bean扫描
服务在线文档生成工具:swagger(v2,v3),springdoc-openapi-ui(jdk8),springdoc-openapi-starter-webmvc-ui(jdk17),有了这些工具后可以为服务接口字段生成openapi在线文档。
表1 支持的区域 区域名称 区域 华北-北京四 cn-north-4
约束与限制 TokenParser实现类与UserStore实现类,均需注册成bean,并完成bean扫描,确保Spring容器中可获取到对应bean。
配置说明 日志配置 使用swagger进行在线API文档配置 父主题: spring-boot-huawei使用指南