【SpringBoot专题_01】springboot集成Knife4J

纸飞机_暖阳

发布于 2024-03-04 17:12:47

880

发布于 2024-03-04 17:12:47

前言

技术栈：springboot、Knife4j gitee源码地址：https://gitee.com/shawsongyue/sevenhee_modules/tree/master/springboot_knife4jSwagger

1.基础maven依赖

        <!--（新版本）swagger增强工具依赖包，方便生成接口文档。非必须导入-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.1</version>
        </dependency>

2.目录结构与配置文件

application.yml

server:
  port: 8080

3.创建knife4j配置文件（Knife4SwaggerConfig.class）

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * knife4版本的swagger配置
 *
 * @author xiaosongyue
 * @date 2021/04/16 11:48:40
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class Knife4SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xsy.sevenhee.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot测试项目")
                .description("项目描述，冲冲冲")
                .version("1.0.0")
                .contact(new Contact("xiaosongyue","http://www.baidu.com","1035336407@qq.com"))
                .license("Home")
                .licenseUrl("http://localhost:8080/swagger-ui.html")
                .build();
    }


}

4.创建controller层（SwaggerController.class）

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

/**
 * swagger控制器
 *
 * @author xiaosongyue
 * @date 2021/04/16 11:26:39
 */
@RestController
@RequestMapping("/swagger")
@Api(value = "swagger模块",tags = "swaggerController")
public class SwaggerController {

    @GetMapping("/add")
    @ApiOperation(value = "增加",notes = "增加信息")
    public String add(String username,String password){
        System.out.println("账号："+username);
        System.out.println("密码："+password);
        return "增加成功";
    }

    @DeleteMapping("/delete")
    @ApiOperation(value = "删除",notes = "删除信息")
    public String delete(String id){
        System.out.println("要删除的id："+id);
        return "删除成功";
    }

    @PostMapping("/update")
    @ApiOperation(value = "修改",notes = "修改信息")
    public String update(String id,String context){
        System.out.println("要删除的id："+id);
        System.out.println("要删除的内容："+context);
        return "修改成功";
    }

    @GetMapping("/select")
    @ApiOperation(value = "查询",notes = "查询信息")
    public String select(){
        System.out.println("开始查询");
        return "查询成功";
    }
}

4.创建主启动类

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * knife4版本的swagger的应用程序
 *
 * @author xiaosongyue
 * @date 2021/04/16 11:47:56
 */
@SpringBootApplication
public class Knife4SwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(Knife4SwaggerApplication.class,args);
    }
}