Knife4j (简单配置就可以使用)

目录

Knife4j的中文文档地址

依赖导入

第二步在自己的application.yaml文件中配置 

---

Knife4j的中文文档地址

Knife4j版本参考 | Knife4j

依赖导入

首先在自己的springboot项目的pom.xml文件中导入knife4j的jar包

<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.5.0</version>
</dependency>

第二步在自己的application.yaml文件中配置 

这样简单配置一下就可以使用了

@Tag(value = "common测试接口")  //这是swagger的tag
@RequestMapping("/common")
@RestController
public class TestController {
    @Autowired
    RedisTemplate redisTemplate;



    @Operation(summary = "hello测试接口") //这是swagger的接口描述
    @RequestMapping("/hello")
    public String test(){

        redisTemplate.opsForValue().set("hello","world");
        return "hello world";
    }

    /*用户登录*/
    @Operation(summary = "用户登录接口") //这是swagger的接口描述
    @Parameters({
            @Parameter(name = "username",description = "用户名",required = true), //这是swagger的参数描述
            @Parameter(name = "password",description = "密码",required = true)
    })
    @RequestMapping("/login")
    public String login(){
        return "sucess";
    }

    @RequestMapping("/test")
    public String devD(){
        return "dev";
    }
}

@Tag(value = "common测试接口")  //这是swagger的tag
@RequestMapping("/common")
@RestController
public class TestController {
    @Autowired
    RedisTemplate redisTemplate;



    @Operation(summary = "hello测试接口") //这是swagger的接口描述
    @RequestMapping("/hello")
    public String test(){

        redisTemplate.opsForValue().set("hello","world");
        return "hello world";
    }

    /*用户登录*/
    @Operation(summary = "用户登录接口") //这是swagger的接口描述
    @Parameters({
            @Parameter(name = "username",description = "用户名",required = true), //这是swagger的参数描述
            @Parameter(name = "password",description = "密码",required = true)
    })
    @RequestMapping("/login")
    public String login(){
        return "sucess";
    }

 
}