yudao-swagger-new-ui高级玩法：动态注入配置与个性化界面定制

yudao-swagger-new-ui高级玩法：动态注入配置与个性化界面定制

【免费下载链接】yudao-swagger-new-uiNEW UI 全新一代的 Swagger UI 支持所有功能，兼容spring boot2x、spring boot3x，未来支持 python、go swagger项目地址: https://gitcode.com/yudaocode/yudao-swagger-new-ui

yudao-swagger-new-ui是全新一代的Swagger UI工具，支持所有Swagger功能，完美兼容Spring Boot 2x和Spring Boot 3x，未来还将支持Python、Go等更多语言的Swagger文档。本文将带你探索其高级玩法，包括动态注入配置和个性化界面定制，让你的API文档既功能强大又独具特色。

一、动态注入配置：灵活定制Swagger UI行为

动态注入配置是yudao-swagger-new-ui的核心特性之一，通过它你可以轻松定制Swagger UI的各种行为。这一功能主要通过SwaggerUiProperties类实现，该类位于yudao-swagger-new-ui-boot-starter/src/main/java/cn/coget/swagger/autoconfigure/SwaggerUiProperties.java。

1.1 配置注入的核心机制

在SwaggerUiProperties类中，有一个关键的属性injectConfig，它是一个Map<String, Object>类型的对象。这个属性允许你注入任意键值对，这些键值对会被自动注入到前端页面的window.SWAGGER_UI_CONFIG对象中，从而影响Swagger UI的行为。

1.2 常用配置示例

以下是一些常用的动态注入配置示例：

# 自定义Swagger UI的访问路径 swagger-new-ui.paths=/api-docs.html,/swagger-ui.html # 设置API文档的基础路径 swagger-new-ui.base-url=/api # 注入自定义配置到前端 swagger-new-ui.inject-config.title=我的API文档 swagger-new-ui.inject-config.default-group=用户管理 swagger-new-ui.inject-config.api-key=your-api-key

这些配置会在应用启动时被读取，并传递给前端页面，从而实现Swagger UI的个性化配置。

二、个性化界面定制：打造专属API文档风格

yudao-swagger-new-ui提供了丰富的界面定制选项，让你可以根据自己的品牌风格和使用习惯来美化API文档界面。

2.1 明暗主题切换

yudao-swagger-new-ui内置了明暗两种主题，你可以根据自己的喜好或使用环境进行切换。

yudao-swagger-new-ui深色主题界面，适合在低光环境下使用，减轻视觉疲劳

yudao-swagger-new-ui浅色主题界面，适合在明亮环境下使用，提供清晰的视觉体验

2.2 自定义样式

如果你需要更深度的界面定制，可以通过修改前端样式文件来实现。相关的样式文件位于ui/src/styles/目录下，包括：

• _base.scss：基础样式定义
• _themes.scss：主题相关样式
• _variables.scss：样式变量定义

通过修改这些文件，你可以自定义颜色、字体、布局等各种视觉元素，打造完全符合自己需求的API文档界面。

三、快速上手：开始你的个性化之旅

3.1 安装与配置

首先，你需要将yudao-swagger-new-ui集成到你的项目中。对于Maven项目，可以通过以下步骤进行：

1. 克隆仓库：

git clone https://gitcode.com/yudaocode/yudao-swagger-new-ui

2. 在你的项目中添加依赖（具体版本请参考项目最新发布）：

<dependency> <groupId>cn.coget</groupId> <artifactId>yudao-swagger-new-ui-boot-starter</artifactId> <version>1.0.0</version> </dependency>

3. 在application.properties或application.yml中添加自定义配置：

swagger-new-ui.inject-config.title=我的API文档 swagger-new-ui.inject-config.theme=light

3.2 探索更多可能性

yudao-swagger-new-ui的灵活性不仅仅体现在上述功能上。通过深入探索examples/目录下的示例项目，你可以发现更多高级用法，如：

• 多模块项目的API文档聚合
• 自定义API分组
• 请求参数的高级配置

四、总结

yudao-swagger-new-ui为开发者提供了强大而灵活的API文档解决方案。通过动态注入配置，你可以轻松定制Swagger UI的各种行为；通过个性化界面定制，你可以打造符合自己品牌风格的API文档。无论是新手还是有经验的开发者，都能快速上手并充分利用这些高级特性，提升API文档的质量和开发效率。

现在就开始你的yudao-swagger-new-ui个性化之旅吧！探索更多可能，让你的API文档脱颖而出。

【免费下载链接】yudao-swagger-new-uiNEW UI 全新一代的 Swagger UI 支持所有功能，兼容spring boot2x、spring boot3x，未来支持 python、go swagger项目地址: https://gitcode.com/yudaocode/yudao-swagger-new-ui