swagger+knife4j引入项目

最新推荐文章于 2024-08-05 15:10:34 发布

bai_student

最新推荐文章于 2024-08-05 15:10:34 发布

阅读量208

点赞数

分类专栏： Java 文章标签： java

本文链接：https://blog.csdn.net/bai_mi_student/article/details/130767707

版权

Java 专栏收录该内容

15 篇文章

订阅专栏

该文介绍了如何在SpringBoot应用中集成Springfox和Knife4j来创建SwaggerAPI文档，包括引入依赖、配置SwaggerConfig以及在Controller中添加注解，最后展示了如何访问生成的文档页面。

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

一、引入依赖

 <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.9</version>
        </dependency>

二、添加config配置文件

package com.example.demo.transactional.utils;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import io.swagger.annotations.ApiOperation;
import lombok.AllArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * Swagger配置
 */
@Configuration
@EnableSwagger2WebMvc
@EnableKnife4j
@AllArgsConstructor
public class SwaggerConfig {
    private final OpenApiExtensionResolver openApiExtensionResolver;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //加了ApiOperation注解的类，生成接口文档
            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
            //包下的类，生成接口文档
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.transactional"))
            .paths(PathSelectors.any())
            .build()
            .extensions(openApiExtensionResolver.buildExtensions("admin"))
            .directModelSubstitute(java.util.Date.class, String.class)
            //.securitySchemes(security())
            ;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("1")
            .description("测试文档")
            .termsOfServiceUrl("https://www.baidu.com")
            .version("1.x")
            .build();
    }
}