Spring Boot使用Swagger3

    io.springfox
    springfox-boot-starter
    3.0.0

在启动类添加@EnableOpenApi

package com.ledao;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;


@EnableOpenApi
@SpringBootApplication
public class SwaggerTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(SwaggerTestApplication.class, args);
    }

}

在Controller类上添加@Api(tags = “该Controller类的用途”)，参数tags主要是描述该Controller类的用途，在Controller类的方法上添加@ApiOperation(value = “该方法的用途”)，参数value主要是描述该方法的用途

package com.ledao.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;


@Api(tags = "首页Controller")
@Controller
public class IndexController {

    @ApiOperation(value = "跳转到首页")
    @ResponseBody
    @GetMapping("/")
    public String root() {
        return "删除学生";
    }
}

浏览器地址栏输入：http://localhost:8080/swagger-ui/

可以看到项目中拥有的Controller类以及该类的方法

点击具体方法可以看到该方法返回的类型以及参数等

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TKkzKmmE-1648055619100)(https://image.zoutl.cn/hexo-blog/blogImage/2021-10-05%20195743.png)]

Swagger3常用注解查看博客：Swagger3常用注解 | LeDao的博客 (zoutl.cn)