Swagger I have used

1swagger configuration class

package com.xxx.xxx.xxx.common.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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;

/**
 * 是否开启swagger，正式环境一般是需要关闭的（避免不必要的漏洞暴露！），可根据springboot的多环境配置进行设置
 */
@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable",  havingValue = "true")
public class SwaggerConfig {

    @Value("${spring.application.name}")
    private String projectName;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.xxx.xxx.xxx.controller")).paths(PathSelectors.any())
                .build();
    }

    /**
     * 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title(projectName + " RESTful API 文档")
                // 版本号
                .version("1.0")
                // 描述
                .description("API 描述")
                .build();
    }
}

2 interception filter


@Configuration
public class WebConfigurer extends WebMvcConfigurationSupport {
 
     @Override
     protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/")
        super.addResourceHandlers(registry);
    }
}

3 Write in the configuration file

顶格swagger:
     enable: true

@Api(tags = "商品管理")
public class HisBedController {
    @PostMapping("/page")
    @ApiOperation(value = "分页查询商品信息")
    public Response pageQuery(@Valid @RequestBody PageParamDTO pageParamDTO) {
        return hisBedService.pageQuery(pageParamDTO.convert());
    }
}

5 visits

For example: 127.0.0.1:8080/doc.html

Or: 127.0.0.1:8080/api prefix/doc.html defined by your own project

Guess you like