Swagger-ui的使用和遇到的問題的處理

導Jar包：

<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>

 

Swagger-ui的配置類：

@Configuration
@EnableSwagger2
@EnableWebMvc
public class WebMvcConfig implements WebMvcConfigurer {

    //這個方法不用動
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    /**
     * swagger2的配置文件，這裏可以配置swagger2的一些基本的內容，比如掃描的包等等
     * @return
     */
    @Bean
    public Docket createRestfulApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("top.dolo.controller")) //暴露接口地址的包路徑
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 構建 api文檔的詳細信息函數,注意這裏的註解引用的是哪個
     * @return
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //頁面標題
                .title("測試的RESTful API")
                //版本號
                .description("訪問接口API")
                .termsOfServiceUrl("http://dologzs.top/")
                .version("1.0")
                .build();
    }

}

 

Controller的簡單配置(主要是看顏色標註的地方)：

@Api(value = "TestController", tags = "TestApi", description = "Testcontroller")
@CrossOrigin
@RestController
@RequestMapping("/test")
public class TestController {

    @Resource
    private TestService service;

 
    @ApiOperation(value="Test", notes="Test")
    @ApiImplicitParam(name = "Test", value = "Test", required = true, dataType = "TestEntity")
    @PostMapping("/test")
    public String annotateWAS(@RequestBody Test test) throws Exception {
        return "Hello  World!";
    }

}

 

關於遇到的問題：

以上配置基本配好了之後，如果出現訪問頁面空白或者不顯示，請清除緩存，清除緩存，清除緩存，清除緩存，清除緩存！

就是瀏覽器緩存的原因，你清一下瀏覽器的緩存就好了，就這麼簡單!

就是瀏覽器緩存的原因，你清一下瀏覽器的緩存就好了，就這麼簡單!

就是瀏覽器緩存的原因，你清一下瀏覽器的緩存就好了，就這麼簡單!

除非你配置不正確！