springfox相关记录

素颜马尾好姑娘i 2023-05-29 05:02 2阅读 0赞

1.springboot为1.5.13版本时，springfox为2.6.0，难以生成正确的swagger文档，升级springfox为2.7.0即可

2.@ApiImplicitParam的dataType，需要是小写开头，不能是大写！！！想要实现返回值是数组或者list，加上allowMultiple=true即可。

3.本地项目生成swagger-ui页面，只要3个配置。启动类加@EnableSwagger2，maven引入springfox，java添加一个SwaggerConfig类。

启动类：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @SpringBootApplication
    @EnableSwagger2
    public class DemoSpringfoxApplication {
    
       public static void main(String[] args) {
          SpringApplication.run(DemoSpringfoxApplication.class, args);
       }
    
    }

maven：

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

SwaggerConfig:

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
    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;
    
    @Configuration
    public class SwaggerConfig extends WebMvcConfigurerAdapter {
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                    // 为当前包路径
                    .apis(RequestHandlerSelectors.basePackage("com.test.springfox")).paths(PathSelectors.any()).build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    // 页面标题
                    .title("测试springfox")
                    // 版本号
                    .version("1.0.0")
                    // 描述
                    .description("API 描述文件").build();
        }
    
    }

最后在代码上加合适的注解，访问http://localhost:8080/swagger-ui.html 就可以看见你的swagger接口文档了

想要文档对应的json，可以访问localhost:8080/v2/api-docs