美文网首页
springboot引入knife4j(swagger3)

springboot引入knife4j(swagger3)

作者: SeekLife0 | 来源:发表于2024-09-08 10:17 被阅读0次

步骤一:
引入依赖

        <!--        swagger         -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-core</artifactId>
            <version>1.2.4</version>
            <scope>compile</scope>
        </dependency>

步骤二:
编写配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("AdminApi")
                .enable(true)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build().securitySchemes(security());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("房淘")
                .description("xxx端开放文档")
                .termsOfServiceUrl("http://101.35.186.202/:8082/swagger-ui.html")
                .build();
    }

    private List<ApiKey> security() {
        return Arrays.asList(
                new ApiKey("登录验证", "X-Mall-Admin-Token", "header")
        );
    }


}

步骤三:
如果配置了WebMvcConfigurer,需要配置拦截器放行静态资源

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        registry.addResourceHandler("doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/favicon.ico")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").
                addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

步骤四:
启动类添加如下注解

@EnableKnife4j

以上完成后,浏览器输入http://localhost:xxxx/doc.html进入swagger页面。

相关文章

网友评论

      本文标题:springboot引入knife4j(swagger3)

      本文链接:https://www.haomeiwen.com/subject/jjmlljtx.html