Springboot整合Swagger2

swagger能解决什么？

1、提供开发接口文档，可供前端或者需要的人调用及调试

2、可以在线测试，不需要使用第三方工具，如postMan

3、接口参数等变更时，可以同步变更

 

整合步骤：

1、加入maven依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

 

2、更改自定义swagger默认配置，可以不自定义，默认使用swagger自带配置

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.beeseven.platform.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars) // 请求token
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("支付项目接口文档")
//                .description("简单优雅的restfun风格，http://blog.csdn.net/saytime")
//                .termsOfServiceUrl("http://blog.csdn.net/saytime")
                .version("1.0")
                .build();
    }
}

3、在启动类配置注解@EnableSwagger2， 表示开启Swagger

/**
 * 启动类
 */
@SpringBootApplication(scanBasePackages = {"com.beesevenrepos.poc"})
@EnableFeignClients
@EnableSwagger2
public class CommonApplication {

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

 

4、在controller中配置注解

@RequestMapping("swagger")
@RestController
@Api(description = "swagger 测试")
public class SwaggerController {

    @ApiOperation(value = "获取用信息")
    @RequestMapping("/getUser")
    public String getUser(AliPayCodeDto aliPayCodeDto){
        return "success";
    }


    @ApiOperation(value = "通过用户id删除用户")
    @GetMapping(value = "/delete")
    public String deleteById(@ApiParam(value = "用户id") String id){
        return "seccess";
    }

}

 

5、当controller中body用对象来传递参数时，我们得去其对象中配置注解

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "支付宝code实体类")
public class AliPayCodeDto implements Serializable {

    @NotBlank(message = "支付宝code不能为空")
    @ApiModelProperty(value = "支付宝code")
    private String code;

}

6、返回地址：http://localhost:2526/swagger-ui.html

注意：当请求没有指定类型时（get，post，put等），会将所有的请求类型都列出，如上图所示

 

注解

• @Api：修饰整个类，描述Controller的作用
• @ApiOperation：描述一个类的一个方法，或者说一个接口
• @ApiParam：单个参数描述
• @ApiModel：用对象来接收参数
• @ApiProperty：用对象接收参数时，描述对象的一个字段
• @ApiResponse：HTTP响应其中1个描述
• @ApiResponses：HTTP响应整体描述
• @ApiIgnore：使用该注解忽略这个API
• @ApiError ：发生错误返回的信息
• @ApiImplicitParam：一个请求参数
• @ApiImplicitParams：多个请求参数