springboot 整合swagger2-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_41018288/article/details/103700885

本文详细介绍如何在SpringBoot项目中整合Swagger2，包括配置Swagger2生成API文档，使用注解进行API说明，以及通过Swagger-UI进行API测试。文章还提供了完整的代码示例和步骤说明。

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

spring boot 整合 swagger2

目录结构
在这里插入图片描述

导入依赖
pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>taskimpl</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>taskimpl</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <springfox-swagger.version>2.9.2</springfox-swagger.version>
    </properties>

    <dependencies>
        <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox-swagger.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox-swagger.version}</version>
        </dependency>  
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

  	<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

spring boot 启动类

@SpringBootApplication
@MapperScan("com.example.mapper")
@EnableSwagger2
public class TaskimplApplication {

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

Swagger2 配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格")
                .version("1.0")
                .build();
    }
}

controller

@Api(value = "demo", tags = {"测试demo"})
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;
    /**
     * 新增
     */
    @ApiOperation(value = "添加内容", notes = "添加内容")
//    @ApiImplicitParams({
//            @ApiImplicitParam(name = "content", value = "内容",  dataType = "String", paramType = "query")
//    })
    @PostMapping("/save")
    public Response save(User user){
        try {
            Boolean save = userService.save(user);
        } catch (Exception e) {
            e.printStackTrace();
        }
         return Response.success();
    }

    /**
     * 删除
     */
    @PostMapping("/delete")
    public Response delete(Long id){
        try {
            Boolean result = userService.deleteUser(id);
        } catch (Exception e) {
            e.printStackTrace();
            return Response.error();
        }
      return Response.success();
    }

    /**
     * 查询
     */
    @PostMapping("/find")
    public Response find(int id){
        User user ;
        try {
             user = userService.findById((long) id);
        } catch (Exception e) {
            e.printStackTrace();
            return Response.build(ResponseCode.ERROR);
        }
        return Response.build(ResponseCode.SUCCESS, user);
    }

    /**
     * 分页查询
     */
    @ApiOperation(value = "获取列表信息", notes = "获取列表信息")
    @GetMapping("/list")
    public Response list(@RequestParam(required = false, defaultValue = "0") int pageNumber,
                            @RequestParam(required = false, defaultValue = "10") int pageSize) {
        PaginationWrapper<User> userByPage;
        try {
            userByPage = userService.getUserByPage(new PaginationModel(pageNumber,pageSize));
        } catch (Exception e) {
            e.printStackTrace();
            return Response.build(ResponseCode.NOT_PAGE);
        }
        HashMap<String, Object> result = new HashMap<>();
        result.put("row", userByPage.getRows());
        result.put("total", userByPage.getTotal());
             return Response.build(ResponseCode.SUCCESS,result);
        }
    }