swagger-bootstrap-ui配置

本文详细介绍如何在项目中集成并配置Swagger,包括添加依赖、创建配置类及访问文档的方法,为API文档自动生成提供了便捷方案。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、添加依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2、添加配置文件

@Configuration
@EnableSwagger2

public class SwaggerConfiguration {


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.study.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger-bootstrap-ui RESTful APIs")
                .description("swagger-bootstrap-ui")
                .termsOfServiceUrl("http://localhost:9099/")
                .version("1.0")
                .build();
    }
}

启动,访问http://localhost:9099/doc.html即可。

<think>好的,我现在要解决的问题是用户想修改swagger-bootstrap-ui的默认访问地址。用户提到默认地址是dom.html,但他们的项目不能使用/xxx的URL结构,需要更改这个路径。我需要根据提供的引用信息,找出解决方法。 首先,我回忆一下用户提供的引用内容。引用[1]中提到用户自己扒拉源码,因为没找到现成的解决方案。引用[4]提到了项目的GitHub地址,可能需要查看源码或文档。但用户说官网上也没找到,所以可能需要通过配置或自定义代码来实现。 接下来,我应该考虑swagger-bootstrap-ui是基于Spring Boot的,通常这类配置可以通过application.properties或application.yml文件进行设置。但根据引用[1],用户说没有现成的配置项,可能需要修改源码中的路径。 可能的步骤包括:查找swagger-bootstrap-ui中处理路由的代码部分,覆盖默认的路径配置。例如,Spring Boot中可以通过@Bean注解自定义配置类,重写资源处理的部分,将默认的dom.html映射到新的路径。 另外,可能需要检查是否有相关的配置属性,例如在引用[3]中提到整合swagger-bootstrap-ui,或许有隐藏的属性可以设置访问路径。但用户提到官网没说明,所以可能需要深入查看项目的文档或源码。 总结可能的解决方案:通过自定义配置类,修改资源处理器,将原来的路径重定向到新的地址。例如,添加一个WebMvcConfigurer的配置类,重写addViewControllers方法,将新的URL路径映射到原来的dom.html文件。或者,修改静态资源的位置,但可能影响其他部分。 需要确保回答中步骤清晰,引导用户如何修改代码,可能包括添加Java配置类,示例代码等。同时要提醒用户可能需要自己编译或调整资源路径,因为官方可能没有直接支持该配置。</think>要修改swagger-bootstrap-ui的默认访问地址,需要通过自定义Spring Boot配置实现。具体步骤如下: ### 配置步骤 1. **新建配置类** 在Spring Boot项目中创建配置类,重写资源映射规则: ```java @Configuration public class SwaggerConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { // 将原路径dom.html映射到新路径new-doc.html registry.addViewController("/new-doc.html") .setViewName("forward:/doc.html"); } } ``` 2. **验证配置有效性** 启动项目后访问新路径: $$http://localhost:8080/new-doc.html$$ 应正常加载Swagger UI界面[^4] ### 原理说明 该配置通过视图控制器将自定义路径`/new-doc.html`映射到swagger-bootstrap-ui的原始路径`/doc.html`,实现了路径重定向效果[^1]。此方法无需修改swagger-bootstrap-ui的源码,避免了直接修改第三方库带来的维护成本。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值