Swagger和Knife4j

Swagger和Knife4j

下面介绍一下Swagger的基本用法第一步引入依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

第二部编写配置类

package com.example.demo.Config;

import io.swagger.annotations.ApiOperation;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @Author gengjiaxin
 * @Description //TODO
 * @Date 2021/9/7 4:40 下午
 **/
@Configuration
public class SwaggerConfig {

    /**
     * 注册bean
     * @return
     */
    @Bean   
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * Swagger基本信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XinYi")
                .description("XinYi接口描述")
                .contact(new Contact("XinYI", "www.xinyi.com", "ggengjx@163.com"))
                .version("v1.0")
                .build();
    }
}

使用注解对相应接口进行描述

在控制层也就是Controller对应的接口上面使用注解

 @ApiOperation(value = "日志线程池测试",notes = "测试线程池和日志切面配置是否正常")

我们同时可以对我们的返回参数类型进行注释例如：

package com.example.demo.test.domain;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.junit.Test;

import java.io.*;

/**
 * @Author gengjiaxin
 * @Description //TODO 该类适用于测试Java提供的序列化和反序列化
 * @Date 2021/9/6 11:17 上午
 **/
@Data
@NoArgsConstructor
@ApiModel(value = "用户类" , description = "用户使用实体类")
public class User implements Serializable {
    private static final long serialVersionUID =2;
    @ApiModelProperty("年龄")
    private int age;
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("用户ID")
    private int id;



}

以上完成后我们就可以启动项目进行测试了，访问下面的网站即可

http://localhost:8080/swagger-ui/index.html#/

通过上述操作我们就能使用Swagger但是我们可能对于Swagger有些嫌弃我们可以使用Knife4j 简单的说就是Swagger的增强使用它我们就有更美观的页面

1. 引入依赖

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

2. 编写配置类

   package com.example.demo.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.service.Contact;
   import springfox.documentation.spi.DocumentationType;
   import springfox.documentation.spring.web.plugins.Docket;
   
   /**
    * @Author gengjiaxin
    * @Description //TODO
    * @Date 2021/9/7 5:35 下午
    **/
   @Configuration
   public class Knife4jConfiguration {
   
       @Bean(value = "KnifeApi")
       public Docket knifeApi() {
           Docket docket=new Docket(DocumentationType.OAS_30)
                   .apiInfo(apiInfo())
                   //分组
                   .groupName("XinYi Api Test")
                   .select()
                   //扫描包路径
                   .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                   .paths(PathSelectors.any())
                   .build();
           return docket;
       }
   
   
       private ApiInfo apiInfo(){
           return new ApiInfoBuilder()
                   .description("XinYi API TEST")
                   .termsOfServiceUrl("http://www.XinYI.com/")
                   .contact(new Contact("XinYi", "www.xinyi.com", "1335339044@qq.com"))
                   .version("1.0")
                   .build();
       }
   }
   
   

   这个配置文档可有可无可以说是如果你没有配置，有Swagger的配置同样是可以使用(可以忽略，个人感觉没有必要)

效果图如下：

以上就是Swagger和Knife4j的使用