前端同事老是说swagger不好用，我用了knife4j后，同事爽得不行

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

import java.util.List;

/**

• 接口配置

• @author yang

• @since

*/

@Configuration

@EnableSwagger2

public class SearchSwaggerConfig {

@Bean

@ConditionalOnExpression(“‘${spring.profiles.active}^{\prime }={=}^{\prime }loca{l}^{\prime }|{|}^{\prime }${spring.profiles.active}’‘dev’ || ‘${spring.profiles.active}’‘isstest’”)

public Docket createRestApi() {

ParameterBuilder tokenPar = new ParameterBuilder();

List pars = new ArrayList<>();

tokenPar.name(“x-token”).description(“token令牌:Bearer”).defaultValue("Bearer ").modelRef(new ModelRef(“string”)).parameterType(“header”).required(false).build();

pars.add(tokenPar.build());

return new Docket(DocumentationType.SWAGGER_2)

.select()

.apis(RequestHandlerSelectors.basePackage(“com.xy.cloud.search.controller”))

.paths(PathSelectors.any())

.build()

.globalOperationParameters(pars)

.apiInfo(apiInfo());

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title(“搜索文档中心 API”)

.version(“v1”)

.build();

}

}

常用注解使用：

@Api()

作用在类上，用来标注该类具体实现内容。

参数：

tags：类标签，一般用来写类的名称或作用。（常用）

description：可描述描述该类作用。

@ApiOperation()

用于方法的说明

参数：

value ：方法说明（常用）

notes ：注释说明

httpMethod ： 说明这个方法被请求的方式

response ：方法的返回值的类型

@ApiOperationSupport()

（knife4j增加特性）用于接口方法排序，作者信息描述等。

参数：

order：排序

author：作者信息

@ApiImplicitParam()

对单个参数的说明

参数：

name ：参数名。

value ： 参数的具体意义，作用。（常用）

required ： 参数是否必填。 （常用）

dataType ：参数的数据类型。 （常用）

paramType ：查询参数类型，这里有几种形式：

类型　　　　　作用

path 　　　以地址的形式提交数据

query 　　直接跟参数完成自动映射赋值

body　　　以流的形式提交 仅支持POST

header　　参数在request headers 里边提交

form　　　以form表单的形式提交 仅支持POST

@ApiModel()

用于描述一个数据模型的信息，即我们常用的实体、VO类、DTO类等描述

参数：

value ： 数据模型名称。（常用）

description:具体描述

parent：父类

@ApiModelProperty()

用于描述数据模型的属性信息

参数：

value：字段说明 （常用）

name：重写属性名字

dataType：重写属性类型

required：是否必填 （常用）

example：举例说明 （常用）

hidden：隐藏

@ApiIgnore

自动生成接口说明时忽略

类：

@Api(value = “搜索中心中文api”)

方法：

@ApiOperation(value=“查询信息”,notes=“查询信息”,httpMethod=“POST”)

@ApiImplicitParam(name = “DirectoryDto” ,value =“文档dto”,dataType =“json”,required = false)

实体：

@ApiModel(“文档dto 返回实体”)

实体属性：

@ApiModelProperty(value = “搜索名称”,dataType = “String”,required=true)

private String name;

@ApiModelProperty(value = “主键id”,dataType = “String”,required=false)

private String id;

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！**

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！