knife4j接口文档配置

引入包

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

配置

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "dockerBean")
    public Docket dockerBean() {
        //指定使用Swagger2规范
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //描述字段支持Markdown语法
                        .description("# ECM APIs")
                        .termsOfServiceUrl("https://")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("XXXXXX")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("XXXX.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

运用

DTO层

@ApiModelProperty(value = "主键")

controller层

@ApiOperation("巡检指标趋势")
@ApiImplicitParams({
        @ApiImplicitParam(name = "planItemId", value = "计划检查部位ID", dataType = "Long", paramType = "query")
})
@GetMapping(value = "/getReportTrend")