Springboot集成knife4j

Springboot集成knife4j

注：本文是 srpingboot + OCLA + knife4j

1. 添加依赖

	 1.1 父工程parent 的pom 文件中引入依赖	 

 <knife4j.version>2.0.2</knife4j.version>
 <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>${knife4j.version}</version>
            </dependency>
            <!-- 如果是单体项目不需要引入下面这个依赖 -->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-micro-spring-boot-starter</artifactId>
                <version>${knife4j.version}</version>
            </dependency>

	1.2 adapter 项目中引入 依赖

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

	1.3 其他需要写请求，响应参数注解的 项目中引入依赖

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

2. 添加swagger配置类

 在adapter 项目中 添加 swagger 配置类

package com.gy.tc.web.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
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.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Author wyw
 * <h5>描述：</h5>
 */
@Configuration // 配置类
@EnableSwagger2 // 开启Swagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfigration {

    @Bean(value = "createRestApi")
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("****接口文档")
                        .description("接口文档")
                        .contact(new Contact("gy", null, null))
                        .version("1.0")
                        .build())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.gy.tc.web")) //controller 扫描路径
                .paths(PathSelectors.any())
                .build();
    }
}

3. 添加注释说明

controller

@Api(tags = "发货单相关接口")
@RestController
@RequestMapping(value = "/delivery_order")
public class DeliveryOrderHeaderController {

    @Value("${tenant.id}")
    private Long tenantId;

    @Autowired
    private DeliveryOrderService deliveryOrderService;

     @ApiOperation("查询订单列表post")
    @PostMapping(value = "getList")
    public GyMultiResponse<DeliveryOrderHeaderDto> getList(DeliveryOrderQry deliveryOrderQry) {
//        DeliveryOrderQry deliveryOrderQry = new DeliveryOrderQry();
        if (deliveryOrderQry == null) {
            deliveryOrderQry = new DeliveryOrderQry();
        }
        deliveryOrderQry.setTenantId(tenantId);
        return deliveryOrderService.getListByQry(tenantId, deliveryOrderQry);
    }

实体类

@ApiModel
public class DeliveryOrderHeaderDto implements Serializable {
    private Integer opState;
    @ApiModelProperty(value = "发货单编码",required = false)
    private String code;
    @ApiModelProperty(value = "店铺id",required = true)
    private Long shopId;

访问路径

	http://localhost:port/doc.html

knife4j 常用参数设置

 Controller层添加注解

@API
@Api：用在请求的类上，表示对类的说明
tags="说明该类的作用，可以在UI界面上看到的注解"
value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

案例

@Api(tags = "HELLO CONTROLLER 测试功能接口")
@RestController
public class HelloController {

}

@ApiOperation
@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

案例

@ApiOperation(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")
@PostMapping(value = "/signUp")
public R SignUp(@RequestBody signUpModelVo signUpModelVo) {
}

@ApiParam
@ApiParam使用在方法上或者参数上，字段说明；表示对参数的添加元数据（说明或是否必填等）
  name: 参数名
  value: 参数说明
  required: 是否必填

案例

@ApiOperation( value = "编辑公告", notes = "编辑公告", httpMethod = "POST" )
    @PostMapping( value = "/edit")
    public RequestResult edit(
            @ApiParam(name = "bis_key", value = "bis_key", required = true) String bisKey,
            @ApiParam(name = "title", value = "公告标题", required = true) @RequestParam String title,
            @ApiParam(name = "content", value = "公告内容", required = true)  String content){
      
    }

@ApiImplicitParams->@ApiImplicitParam
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

案例

@ApiImplicitParams({
    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
})

@ApiResponses->@ApiResponse
@ApiResponses：用于请求的方法上，表示一组响应
  @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  code：数字，例如400
  message：信息，例如"请求参数没填好"
  response：抛出异常的类

案例
@ApiOperation(value = "select1请求",notes = "多个参数，多种的查询参数类型")
@ApiResponses({
    @ApiResponse(code=400,message="请求参数没填好"),
    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})

@ApiIgnore
	忽略掉指定的接口和类，在开发中肯定存在一些用于跳转路由的controller，那么其实这部分是不需要把接口呈现给其他开发人员的，所以就可以通过@ApiIgnore注解忽略掉该注解

案例

@RequestMapping("/admin/user")
@RestController
@ApiIgnore
public class AdminUserRestController {
	//...
}

Bean实体类层注解
@ApiModel->ApiModelProperty
@ApiModel：用于响应类上，表示一个返回响应数据的信息
  (这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty：用在属性上，描述响应类的属性

案例

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{
 
    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;
 
    /* getter/setter */
}