springboot集成Knife4j

界面效果(http://127.0.0.1:8013/doc.html)

开始操作

pom.xml

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

Knife4jConfiguration.java

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact("xx@qq.com")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.xcl.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

 User.java

import com.baomidou.mybatisplus.annotation.*;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.Date;

@Data
@TableName("tabl_user")
@ApiModel( description="用户信息对象")
public class User {
    @TableId(value = "ID", type = IdType.ASSIGN_UUID)
    @ApiModelProperty(value = "主键ID",required = true)
    private String id;
    @ApiModelProperty(value = "姓名",required = true)
    private String name;
    @ApiModelProperty(value = "性别")
    private Integer sex;
    @ApiModelProperty(value = "年龄")
    private Integer age;
    @ApiModelProperty(value = "邮箱")
    private String email;
    @TableField(fill = FieldFill.INSERT)
    @ApiModelProperty(value = "创建时间")
    private Date createtime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @ApiModelProperty(value = "修改时间")
    private Date updatetime;
}

 X.java

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

@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(description="返回信息对象")
public class X<T> {

    @ApiModelProperty(value = "返回编码")
    private Integer code;
    @ApiModelProperty(value = "返回标注")
    private String msg;
    @ApiModelProperty(value = "返回数据")
    private T data;

    public static <T> X ResData(Integer code, String msg, T data){
        return new X(code,msg,data);
    }

    public static <T> X ResData(DataEnum dataenum, T data){
        return new X(dataenum.getCode(),dataenum.getMsg(),data);
    }
}

SaveAction.java

import com.xcl.pojo.User;
import com.xcl.resdata.DataEnum;
import com.xcl.resdata.X;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/*Save相关api*/
@Api(tags = "Save模块")
@RestController
public class SaveAction {
    @Autowired
    com.xcl.service.UserService UserService;

    // 拓展
    @ApiOperation(value = "添加拓展")
    @PostMapping("/saveuser")
    public X saveuser(@RequestBody User user) {

        boolean b = UserService.save(user);

        return X.ResData(DataEnum.SUCCESS,user);
    }

}