swagger与springboot使用的方式_spring boot使用swagger怎么用对象来接收-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_41168868/article/details/103258451

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括pom文件添加依赖、配置Swagger、使用注解生成API文档等步骤，助您快速上手。

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

1.pom文件添加依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.Swagger配置类

package com.lkw.swagger.config;


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.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lkw.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格，https://me.youkuaiyun.com/blog/miachen520")
                .termsOfServiceUrl("https://me.youkuaiyun.com/blog/miachen520")
                .version("1.1.0")
                .build();
    }
}

开启Swagger

在启动类上添加注解

swagger2注解介绍:

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等，如：
@ApiIgnore：使用注解忽略该API，不会参与文档生成
@ApiOperation：描述该api,如： @ApiOperation(value=”创建用户”, notes=”根据User对象创建用户”)
请求方法：@RequestMapping(value = “user”, method = RequestMethod.POST)
参数x信息：@ApiImplicitParam(name = “user”, value = “用户详细实体user”, required = true, dataType = “User”)
@Api：修饰整个类，描述Controller的作用
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiResponses：HTTP响应整体描述
@ApiProperty：用对象接收参数时，描述对象的一个字段

最后启动项目

访问

http://localhost:8080/swagger-ui.html#/

就可以看到