knife4j的入门使用

Mr.lir

已于 2024-07-10 14:00:52 修改

阅读量267

点赞数

分类专栏： Java 文章标签： spring java spring boot

于 2023-03-09 15:42:57 首次发布

本文链接：https://blog.csdn.net/Liron_wg/article/details/129424129

版权

Java 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

knife4j的入门使用

在使用knife前，建议先掌握swagger的注解使用方式。

1.为项目导入knife4j的依赖

引入knife4j前应当先删除swagger的依赖

<dependency>
     <groupId>com.github.xiaoymin</groupId>
     <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>

如果是高版本的springboot项目则还应当添加以下的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.添加配置类

package com.liron.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.HashSet;

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {

   @Bean
   public Docket buildDocket() {
      HashSet<String> strings = new HashSet<>();
      strings.add("application/json");

      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(buildApiInfo())
              //设置返回值数据类型为json
              .produces(strings)
              .select()
              // 要扫描的API(Controller)基础包
              .apis(RequestHandlerSelectors.basePackage("com.liron"))
              .paths(PathSelectors.any())
              .build();
   }

   private ApiInfo buildApiInfo() {
      Contact contact = new Contact("liron","","");
      return new ApiInfoBuilder()
              .title("liron`s project interface document")
              .description("测试案例api")
              .contact(contact)
              .version("1.0.0").build();
   }
}