快捷導(dǎo)航

解決springboot集成swagger碰到的坑(報(bào)404)

更新時(shí)間：2021年06月11日 14:34:47 作者：white_ice

這篇文章主要介紹了解決springboot集成swagger碰到的坑(報(bào)404)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

一：項(xiàng)目使用springboot集成swagger進(jìn)行調(diào)試

配置swagger非常簡單，主要有三步：

1、添加swagger依賴

<!-- 引入 swagger等相關(guān)依賴 -->
<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>

2、進(jìn)行swagger的配置

package com.sailing.springbootmybatis.config;
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;
 
/**
 * @author baibing
 * @project: springboot-mybatis
 * @package: com.sailing.springbootmybatis.config
 * @Description: swagger2配置類
 * @date 2018/9/25 15：35
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sailing.springbootmybatis.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("SPRING-BOOT整合MYBATIS--API說明文檔")
                .description("2018-8完成版本")
                .contact("Sailing西安研發(fā)中心-baibing")
                .version("1.0")
                .license("署名-非商用-相同方式共享 4.0轉(zhuǎn)載請(qǐng)保留原文鏈接及作者")
                .licenseUrl("https://creativecommons.org/licenses/by-nc-sa/4.0/")
                .build();
    }
}

3、在controller層添加相應(yīng)的注解（@Api 和 @ApiOperation 以及 @ApiIgnore 等）

package com.sailing.springbootmybatis.controller;
import com.sailing.springbootmybatis.bean.Userinfo;
import com.sailing.springbootmybatis.common.log.LogOperationEnum;
import com.sailing.springbootmybatis.common.log.annotation.MyLog;
import com.sailing.springbootmybatis.common.response.BuildResponseUtil;
import com.sailing.springbootmybatis.common.response.ResponseData;
import com.sailing.springbootmybatis.common.websocket.WebSocketServer;
import com.sailing.springbootmybatis.service.RedisService;
import com.sailing.springbootmybatis.service.UserinfoService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
import javax.validation.Valid;
import java.io.IOException;
import java.util.List;
 
/**
 * @author baibing
 * @project: springboot-mybatis
 * @package: com.sailing.springbootmybatis.controller
 * @Description: Userinfo controller 控制層
 * @date 2018/9/12 10:07
 */
@RestController
@Api(value = "USERINFO", description = "用戶信息測(cè)試controller")
public class UserinfoController{
    @Autowired
    private UserinfoService userinfoService;
    @Autowired
    private WebSocketServer webSocketServer;
    @Autowired
    private RedisService redisService;
    /**
     * 查找指定id對(duì)應(yīng)的用戶
     * @param id
     * @return
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    @MyLog(type = LogOperationEnum.SELECT,value = "查詢指定id的用戶信息")
    @ApiOperation(value = "查詢指定id的用戶信息接口", notes = "查詢指定id的用戶信息接口")
    public ResponseData getUser(@PathVariable(value = "id") Integer id){
        return userinfoService.findById(id);
    }
    /**
     * 查找所有用戶
     * @return
     */
    @RequestMapping(value = "/users", method = RequestMethod.GET)
    @MyLog(type = LogOperationEnum.SELECT,value = "查詢?nèi)坑脩粜畔?)
    @ApiOperation(value = "查詢所有用戶信息接口", notes = "查詢所有用戶信息接口")
    public ResponseData getAllUsers(){
        return userinfoService.findAllUsers();
    }
 
    /**
     * 查找所有用戶（帶分頁）
     * @param page 當(dāng)前頁數(shù)
     * @param rows 每頁顯示條數(shù)
     * @return
     */
    @RequestMapping(value = "/users/p", method = RequestMethod.GET)
    @ApiOperation(value = "查詢所有用戶信息接口(帶分頁)", notes = "查詢所有用戶信息接口(帶分頁)")
    public ResponseData getAllUsers(Integer page, Integer rows){
        return userinfoService.findAllUsers(page, rows);
    }
 
    /**
     * 新增用戶 (帶參數(shù)校驗(yàn)@Valid)
     * 注意：BindingResult 對(duì)象必須在 @Valid 的緊挨著的后面，否則接收不到錯(cuò)誤信息
     * @Valid 可以校驗(yàn)json 也可以校驗(yàn)表單傳遞的對(duì)象屬性
     * @param userinfo
     * @return
     */
    @RequestMapping(value = "/user", method = RequestMethod.POST)
    @MyLog(type = LogOperationEnum.INSERT, value = "新增用戶信息")
    @ApiOperation(value = "新增用戶接口(包含參數(shù)校驗(yàn))", notes = "新增用戶接口(包含參數(shù)校驗(yàn))")
    public ResponseData saveUserinfo(@RequestBody @Valid Userinfo userinfo, BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            return BuildResponseUtil.buildFailResponse(bindingResult.getFieldError().getDefaultMessage());
        }
        return userinfoService.saveUser(userinfo);
    }
 
    /**
     * 刪除指定用戶
     * @param id 用戶id
     * @return
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
    @ApiOperation(value = "刪除指定id的用戶信息接口", notes = "刪除指定id的用戶信息接口")
    public ResponseData deleteUser(@PathVariable Integer id){
        return userinfoService.deleteUser(id);
    }
 
    /**
     * 更新用戶
     * @param userinfo
     * @return
     */
    @RequestMapping(value = "/user", method = RequestMethod.PUT)
    @ApiOperation(value = "更新指定id用戶信息接口", notes = "更新指定id用戶信息接口")
    public ResponseData updateUserinfo(@RequestBody Userinfo userinfo){
        return userinfoService.updateUser(userinfo);
    }
 
    /**
     * 給指定用戶推送消息
     * @param userName 用戶名
     * @param message 消息
     * @throws IOException
     */
    @RequestMapping(value = "/socket", method = RequestMethod.GET)
    @ApiIgnore //使用此注解忽略方法的暴露，也可以用在controller上
    @ApiOperation(value = "給指定用戶推送socket消息接口", notes = "給指定用戶推送socket消息接口")
    public void testSocket(@RequestParam String userName,@RequestParam String message){
        webSocketServer.sendInfo(userName, message);
    }
 
    /**
     * 測(cè)試redis接口保存String類型action
     * @param address
     * @return
     */
    @RequestMapping(value = "/redis", method = RequestMethod.POST)
    @ApiIgnore //使用此注解忽略方法的暴露，也可以用在controller上
    @ApiOperation(value = "redis中添加String數(shù)據(jù)接口", notes = "redis中添加String數(shù)據(jù)接口")
    public ResponseData setString(@RequestBody String address){
        System.out.println(address);
        return redisService.setValue(address);
    }
 
    /**
     * 測(cè)試redis接口保存實(shí)體類型action
     * @param userinfo
     * @return
     */
    @RequestMapping(value = "/redis/userinfo", method = RequestMethod.POST)
    @ApiIgnore //使用此注解忽略方法的暴露，也可以用在controller上
    @ApiOperation(value = "redis中添加Userinfo實(shí)體接口", notes = "redis中添加Userinfo實(shí)體接口")
    public ResponseData setEntity(@RequestBody Userinfo userinfo){
        return redisService.setEntityValue(userinfo);
    }
    /**
     * 測(cè)試redis接口讀取實(shí)體類型action
     * @param key
     * @return
     */
    @RequestMapping(value = "/redis/userinfo/{key}", method = RequestMethod.GET)
    @ApiIgnore //使用此注解忽略方法的暴露，也可以用在controller上
    @ApiOperation(value = "redis中讀取指定key對(duì)應(yīng)的數(shù)據(jù)接口", notes = "redis中讀取指定key對(duì)應(yīng)的數(shù)據(jù)接口")
    public ResponseData getEntity(@PathVariable String key){
        return redisService.getEntityValue(key);
    }
 
    /**
     *
     * @param list
     * @return
     */
    @RequestMapping(value = "/redis/userList", method = RequestMethod.POST)
    @ApiIgnore //使用此注解忽略方法的暴露，也可以用在controller上
    @ApiOperation(value = "redis中添加包含Userinfo實(shí)體的集合接口", notes = "redis中添加包含Userinfo實(shí)體的集合接口")
    public ResponseData setCollection(@RequestBody List<Userinfo> list){
        return redisService.setCollectionValue(list);
    }
 
    /**
     * 測(cè)試redis接口讀取實(shí)體類型action
     * @param key
     * @return
     */
    @RequestMapping(value = "/redis/userList/{key}", method = RequestMethod.GET)
    @ApiOperation(value = "redis中讀取指定key對(duì)應(yīng)的集合數(shù)據(jù)接口", notes = "redis中讀取指定key對(duì)應(yīng)的集合數(shù)據(jù)接口")
    public ResponseData getCollection(@PathVariable String key){
        return redisService.getCollectionValue(key);
    }
}

二：到這里配置就結(jié)束了

訪問 http://127.0.0.1:端口/項(xiàng)目路徑/swagger-ui.html 就ok了，頁面如下：

swagger-ui界面展示

三：項(xiàng)目運(yùn)行了一段時(shí)間后訪問上面連接突然報(bào) 404 錯(cuò)誤

百思不得其解，但是可以肯定的是加了什么配置導(dǎo)致，最后在application.yml 中發(fā)現(xiàn)了一個(gè)配置：

spring.mvv.resources.add-mapping:false

將其注釋掉熟悉的界面又回來了，查閱資料發(fā)現(xiàn)這個(gè)配置是不自動(dòng)給靜態(tài)資源添加路徑，導(dǎo)致swagger-ui.html找不到資源，知道原因后摸索看能不能在保留以上配置的前提下自己手動(dòng)給swagger-ui.html添加靜態(tài)資源路徑呢？

package com.sailing.springbootmybatis.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
/**
 * 在SpringBoot2.0及Spring 5.0 WebMvcConfigurerAdapter已被廢棄，目前找到解決方案就有
 * 1 直接實(shí)現(xiàn)WebMvcConfigurer （官方推薦）
 * 2 直接繼承WebMvcConfigurationSupport
 * @ https://blog.csdn.net/lenkvin/article/details/79482205
 */
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
    @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/");
    }
}

發(fā)現(xiàn)通過以上代碼手動(dòng)給swagger-ui.html指定路徑也可以解決404的問題。