knife4j使用与步骤

梁山教父

已于 2024-01-17 16:36:24 修改

阅读量1.1k

点赞数

文章标签： java spring 数据库

于 2023-01-11 15:45:54 首次发布

本文链接：https://blog.csdn.net/weixin_55127182/article/details/128645766

版权

1、导入依赖


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

2、knife4j的配置类（可有可无）


package com.common.config;


import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableOpenApi
public class Knife4jConfig {
    @Bean
    public Docket docket() {
        Docket docket = new Docket(DocumentationType.OAS_30)
            .apiInfo(new ApiInfoBuilder()
                .title("接口文档")
                .description("信息描述")
                // .termsOfServiceUrl("http://www.xx.com/")
                .contact(new Contact("knife", "https://knife.blog.csdn.net/", "xx@qq.com"))
                .version("1.0")
                .build())
            // 分组名称
            .groupName("all")
            .select()
            // 这里指定Controller扫描包路径
            .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .paths(PathSelectors.any())
            .build();

        return docket;
    }

}

3、访问地址（段口为自己tomcat的服务器端口）

http://localhost:8085/doc.html

4、演示

5、Api的使用与swagger使用相同，请查看

(84条消息) swagger的使用与步骤_梁山教父的博客-CSDN博客

6、使用位置

①可以放在单独的common工程，在里面导入依赖，并且配置其knife4j的配置类

②在其他工程中导入这个工程的maven坐标，并且在启动的扫描包的地址


package com.swagger;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@EnableOpenApi
@SpringBootApplication(scanBasePackages = {
    "com.swagger",
    "com.common"
})
public class SwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SwaggerApplication.class, args);
    }

}

③这样就可以不用每个模块都进行配置就可以使用knife

7、使用idea插件自动生成swagger的注解，这样便可以不用每次去手写注解

注意，自动生成注解通过接口的注释来自动化生成（所以要有写好注释的习惯）

①搜索Swagger Tools

②安装以后，在所处需要添加的代码右键生成便可以通过注释生成注解


/**
 * 日志
 */
@Api(value = "/logback", tags = {"日志"})
@RestController
@RequestMapping("/logback")
@CrossOrigin
@Slf4j
public class LogbackController {
    /**
     * 测试
     * @return
     */
    @ApiOperation(value = "测试", notes = "测试", httpMethod = "GET")
    @GetMapping("/test")
    @ResponseBody
    public R test(){
        log.error("error");
        log.warn("warn");
        log.info("info");
        log.debug("debug");
        log.trace("trace");
        return R.ok("success").setCode(200);
    }
}

③实体类根据注释自动生成注解


package com.logback.domain;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import java.util.Date;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * 系统日志
 * @TableName pd_common_opt_log
 */
@ApiModel(description = "系统日志")
@TableName(value ="pd_common_opt_log")
@Data
public class Log implements Serializable {
    /**
     * 主键
     */

    @ApiModelProperty("主键")
    @TableId(value = "id")
    private Long id;

    /**
     * 操作IP
     */

    @ApiModelProperty("操作IP")
    @TableField(value = "request_ip")
    private String request_ip;

    /**
     * 日志类型
#LogType{OPT:操作类型;EX:异常类型}
     */
    @ApiModelProperty("日志类型LogType{OPT:操作类型;EX:异常类型}")
    @TableField(value = "type")
    private String type;

    /**
     * 操作人
     */
    @ApiModelProperty("操作人")
    @TableField(value = "user_name")
    private String user_name;

    /**
     * 操作描述
     */
    @ApiModelProperty("操作描述")
    @TableField(value = "description")
    private String description;

    /**
     * 类路径
     */
    @ApiModelProperty("类路径")
    @TableField(value = "class_path")
    private String class_path;

    /**
     * 请求方法
     */
    @ApiModelProperty("请求方法")
    @TableField(value = "action_method")
    private String action_method;

    /**
     * 请求地址
     */
    @ApiModelProperty("请求地址")
    @TableField(value = "request_uri")
    private String request_uri;

    /**
     * 请求类型
#HttpMethod{GET:GET请求;POST:POST请求;PUT:PUT请求;DELETE:DELETE请求;PATCH:PATCH请求;TRACE:TRACE请求;HEAD:HEAD请求;OPTIONS:OPTIONS请求;}
     */
    @ApiModelProperty("请求类型HttpMethod{GET:GET请求;POST:POST请求;PUT:PUT请求;DELETE:DELETE请求;PATCH:PATCH请求;TRACE:TRACE请求;HEAD:HEAD请求;OPTIONS:OPTIONS请求;}")
    @TableField(value = "http_method")
    private String http_method;

    /**
     * 请求参数
     */
    @ApiModelProperty("请求参数")
    @TableField(value = "params")
    private String params;

    /**
     * 返回值
     */
    @ApiModelProperty("返回值")
    @TableField(value = "result")
    private String result;

    /**
     * 异常详情信息
     */
    @ApiModelProperty("异常详情信息")
    @TableField(value = "ex_desc")
    private String ex_desc;

    /**
     * 异常描述
     */
    @ApiModelProperty("异常描述")
    @TableField(value = "ex_detail")
    private String ex_detail;

    /**
     * 开始时间
     */
    @ApiModelProperty("开始时间")
    @TableField(value = "start_time")
    private Date start_time;

    /**
     * 完成时间
     */
    @ApiModelProperty("完成时间")
    @TableField(value = "finish_time")
    private Date finish_time;

    /**
     * 消耗时间
     */
    @ApiModelProperty("消耗时间")
    @TableField(value = "consuming_time")
    private Long consuming_time;

    /**
     * 浏览器
     */
    @ApiModelProperty("浏览器")
    @TableField(value = "ua")
    private String ua;

    /**
     *
     */
    @ApiModelProperty("")
    @TableField(value = "create_time")
    private Date create_time;

    /**
     *
     */
    @ApiModelProperty("")
    @TableField(value = "create_user")
    private Long create_user;

    @ApiModelProperty(hidden = true)
    @TableField(exist = false)
    private static final long serialVersionUID = 1L;
}

4、如果出现org.springframework.context.ApplicationContextException: Failed to start bean ‘documentationPluginsB报错

跳转地址