快捷導航

knife4j?整合?springboot的過程詳解

更新時間：2023年09月04日 10:35:52 作者：19783793

這篇文章主要介紹了knife4j整合springboot的過程,本次整合springboot版本為2.3.12，本文通過圖文實例相結(jié)合給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

1.引入依賴：

    <!-- knife4j-spring-boot-starter:(3.0 ~ 3.0.3 是過度版本，官方不建議使用) -->
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <version>2.0.9</version>
    </dependency>

注意：本次整合springboot版本為2.3.12

2.配置類

Configuration
@EnableKnife4j
@EnableSwagger2WebMvc  // 如果是 knife4j 3.x版本，則只需要去除掉該注解即可
public class SwaggerConfig {
    private String basePackage = "com.xxx.xxx.controller";
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .groupName("api")
                .enable(true)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage)) // 基于包掃描
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))  // 基于注解
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) 
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API 接口文檔")
                .description("Restful API 接口文檔")
                .version("1.0")
                .contact(new Contact("聯(lián)系人姓名","聯(lián)系人url","聯(lián)系人email"))
                .termsOfServiceUrl("服務(wù)條款URL")
                .license("xxx License Version 1.0")
                .licenseUrl("http://www.xxx.xxx/licenses/LICENSE-1.0")
                .build();
    }
}

3.配置文件

# 版本建議：3.0~3.0.3   底層依賴springfox框架版本升級至3.0.3,OpenAPI規(guī)范是v3,過度版本，建議開發(fā)者不要使用
knife4j.enable=true
# 是否開啟生產(chǎn)環(huán)境屏蔽   true:關(guān)閉swagger，false:開啟swagger
# true - 設(shè)置未true報錯：You do not have permission to access this page - 即生產(chǎn)環(huán)境禁止訪問
knife4j.production=false
knife4j.setting.language=zh-CN

4.編寫代碼Controller

@Api(tags = "測試接口")
@Controller
@RequestMapping("/test")
public class TestController {
    @Autowired
    private RedisTemplate redisTemplate;
    @ApiOperation("set value 操作")
    @ResponseBody
    @RequestMapping(value = "/set", method = RequestMethod.POST)
    public String setVal(String key, String value) {
        redisTemplate.opsForValue().set(key, value);
        return "success set val";
    }
    @ApiOperation("get 操作")
    @ResponseBody
    @RequestMapping(value = "/get", method = RequestMethod.GET)
    public String getValue(String key) {
        String result = (String) redisTemplate.opsForValue().get(key);
        System.err.println("======> 返回結(jié)果result：" + result);
        return result;
    }
}