检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用swagger进行在线API文档配置 文档配置 spring-boot-starter-huawei添加了swagger2和swagger3包的依赖,API在线文档使用springdoc-openapi-ui。
表1 创建子域参数说明 参数 说明 子域名称 输入子域名称,名称只能包含大小写字母、数字、连字符(-)和下划线(_)。 名称必须唯一,不能重复。 描述 设置子域的描述信息,只包含数字、大小写字母、汉字、空格和常用符号(‘’:?。,!;()'?:.,!;()-_@)的字符串。
表1 编辑子域参数说明 参数 说明 子域名称 输入子域名称,名称只能包含大小写字母、数字、连字符(-)和下划线(_)。 名称必须唯一,不能重复。 描述 设置子域的描述信息,只包含数字、大小写字母、汉字、空格和常用符号(‘’:?。,!;()'?:.,!;()-_@)的字符串。
表1 支持的区域 区域名称 区域 华北-北京四 cn-north-4
工作原理 引入devspore-auth-starter依赖后,会在SDK内自动注册认证Filter:AuthAuthenticationFilter。
实际应用中请换成自己对应的域名。
插件均需注册为bean。
入门准备工作 注册华为账号并实名认证 如果您已有一个华为账号,请跳到下一个任务。如果您还没有华为账号,请参考以下步骤创建。 进入华为云官网,单击页面右上角的“注册”。 参考注册华为账号并开通华为云中操作,完成注册。
用户自定义认证使用 工作原理 引入devspore-auth-starter依赖后,会在SDK内自动注册认证Filter:AuthAuthenticationFilter。
插件均需注册为bean。
Exit类插件采用的是观察者模式(Observer),所有的插件作为观察者注册,DevSpore运行时库里的Publisher模块同时调用所有的观察者插件(插件可能被并发执行且执行的顺序随机),插件执行的结果不能影响请求返回。
图5 云服务设置 注册发现/配置中心 不启用:不对接配置管理服务。 CSE:使用微服务引擎服务CSE作为配置管理服务。
ref:接受一个内部值,返回一个响应式的、可更改的ref对象,此对象只有一个指向其内部值的属性。 更多参数说明详情请参考vuejs。 父主题: 前端应用管理
初始值类型:可选择“JSON类型”和“JS表达式类型” 初始值:数据写法和JS写法一致。
注册发现/配置中心 注册发现/配置中心。 不启用:不对接配置管理服务。 CSE:使用微服务引擎服务CSE作为配置管理服务。
编辑key值,及词条中文和英文内容。 创建词条时key值会自动生成,也可以自定义输入。 key值需为唯一值,不可与现有key值重复。 创建后key值不可修改。 图1 新增词条 单击页面空白处,完成国际化词条创建。
绑定成功后可根据变量state.isLogin的值,查看渲染效果。 图3 state.isLogin为false时 图4 state.isLogin为ture时 父主题: 配置高级设置
服务在线文档生成工具:swagger(v2,v3),springdoc-openapi-ui(jdk8),springdoc-openapi-starter-webmvc-ui(jdk17),有了这些工具后可以为服务接口字段生成openapi在线文档。
配置项的具体值含义参考配置说明 devspore-probe的配置样例: 1 2 3 4 5 devspore: probe: metrics: tags: component: demo-application
配置说明 日志配置 使用swagger进行在线API文档配置 父主题: spring-boot-huawei使用指南