Knif4j文档设置Header描述

在有请求头Header的API文档中，需要通过代码把Header参数及描述也生成到API文档，方便查看和使用。

本文使用Knif4j文档，展示设置Header的关键代码。

请求头实体

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

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 登录传输体
 * @date 2023/3/13 3:29 PM
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "UserDto", description = "登录传输体")
public class AuthenticationDto {

    @ApiModelProperty(value = "链code", required = true)
    private String chainCode;

    @ApiModelProperty(value = "合约地址", required = true)
    private String dacContractAddress;

    @ApiModelProperty(value = "私钥", required = true)
    private String privateKey;
}

控制层设置Header

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 资产操作模块
 * @date 2023/5/11 11:26 PM
 */
@RestController
@RequestMapping(value = "/handle")
@Api(tags = "资产操作模块")
public class DACHandleController {

    /** 注入服务层 */
    private DacService dacService;

    @Autowired
    public void setDacService(DacService dacService) {
        this.dacService = dacService;
    }

    @ApiImplicitParams({
        @ApiImplicitParam(name = "chainCode", value = "链code", paramType = "header"),
        @ApiImplicitParam(name = "dacContractAddress", value = "合约地址", paramType = "header"),
        @ApiImplicitParam(name = "privateKey", value = "私钥", paramType = "header")
    })
    @PostMapping(value = "/createCategory")
    @ApiOperation(value = "创建DAC类别", notes = "创建DAC类别")
    public Result<CreateCategoryResp> createCategory(
            @VerifyAuthentication AuthenticationDto authentication,
            @Valid @RequestBody CreateCategoryReq createCategoryReq) {
        return Result.success(dacService.createCategory(authentication, createCategoryReq));
    }

}

其中，

ApiImplicitParams实现请求头Header的描述；

CreateCategoryReq实体中的属性，自带描述，为application/json形式的请求参数，会自动生成到文档。