SpringBoot添加Swagger2支持可直接供前端及测试使用生产环境禁用

最新推荐文章于 2024-09-07 22:27:57 发布

跟心爱的人浪迹天涯

最新推荐文章于 2024-09-07 22:27:57 发布

阅读量408

点赞数

分类专栏： java SpringBoot 文章标签： springboot swagger2

本文链接：https://blog.csdn.net/guandongsheng110/article/details/110489541

版权

java 同时被 2 个专栏收录

58 篇文章 0 订阅

订阅专栏

SpringBoot

9 篇文章 1 订阅

订阅专栏

pom.xml

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

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

config

ConditionalOnProperty表示在配置文件中添加swagger.enable=true之后, 此类才会被加载, swagger才可以被使用, 可用于测试生产环境做不同配置

@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.smartdevice")) // 扫描包路径
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("Service接口文档")
                .contact(new Contact("GuanDS", "https://blog.csdn.net/guandongsheng110", "156545385@qq.com"))
                .version("1.0.0")
                .build();
    }
}

yml

swagger:
  enable: true

Controller

类上添加@Api, 方法上添加@ApiOperation

@RestController
@Api("设备日志")
public class DeviceLogController implements DeviceLogFeign {

    @Autowired
    private DeviceLogService deviceLogService;

    @Override
    @ApiOperation(value = "设备列表")
    public PageInfo<DeviceLogResponse> list(DeviceLogRequest request) 
        return null;
    }
}

DTO

对象上添加@ApiModel, 属性上添加@ApiModelProperty

@Data
@ApiModel(value = "设备列表")
public class DeviceLogRequest {
	@ApiModelProperty(value = "页码 默认1")
    private int pageNum = 1;

    @ApiModelProperty(value = "每页条数 默认20")
    private int pageSize = 20;
}