超简单配置接口文档Swagger和Knife4j教程

前言：

这里介绍了如何配置Swagger和Knife4j 3.0版本，强烈建议大家使用Knife4j，因为它的前身是swagger-bootstrap-ui，是在Swagger的基础上进行了界面的优化，使用起来比Swagger舒服了太多

1.配置Swagger

1.首先在pom.xml中加入依赖

springboot 2.2.x以下版本和 2.2.x以上版本使用依赖不同

<!--如果使用的springboot是 2.2.x 以下版本，需要同时配置springfox-swagger2 和 springfox-swagger-ui-->
 <dependencies>
	<dependency>
	    <groupId>org.springframework.boot</groupId>
	    <artifactId>spring-boot-starter-web</artifactId>
	    <version>2.1.3.RELEASE</version>
	</dependency>
    
	<dependency>
	     <groupId>io.springfox</groupId>
	     <artifactId>springfox-swagger2</artifactId>
	     <version>2.9.2</version> <!-- 这是一个与Spring Boot 2.1.x兼容的版本 -->
	 </dependency>
	 <dependency>
	     <groupId>io.springfox</groupId>
	     <artifactId>springfox-swagger-ui</artifactId>
	     <version>2.9.2</version> <!-- 保持与springfox-swagger2的版本一致 -->
	 </dependency>
</dependencies>

 <!-- 如果使用的springboot是 2.2.x 以上版本，可以直接引入springfox-boot-starter-->
dependencies>
	<dependency>
	    <groupId>org.springframework.boot</groupId>
	    <artifactId>spring-boot-starter-web</artifactId>
	    <version>2.2.13.RELEASE</version>
	</dependency>
    
	<dependency>
	    <groupId>io.springfox</groupId>
	    <artifactId>springfox-boot-starter</artifactId>
	    <version>3.0.0</version>
	</dependency>
</dependencies>

2.加入配置文件

package com.example.demo.config;

import io.swagger.annotations.ApiOperation;
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@EnableOpenApi   // 开启Swagger自定义接口文档
@Configuration   // 相当于Spring配置中的<beans>
public class SwaggerConfig {
	// 读取yaml中的配置
   @Value("${swagger.enable}")
    private Boolean enable;

    @Bean   // 相当于Spring 配置中的<bean>
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                // 配置swagger是否生效
                .enable(enable)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
     //           .apis(RequestHandlerSelectors.basePackage("com.yourcompany.yourproject.controller")) // 替换为你的controller包路径  
                .paths(PathSelectors.any())
                .build();
    }
    // API基础信息定义（就是更新Swagger默认页面上的信息）
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3接口文档测试")
                .description("这里是文档描述")
                .contact(new Contact("小盛", "网址", "邮箱"))
                .version("v1.0")
                .build();
    }
}

3.创建一个controller

@RestController
@RequestMapping(value = "/api/v2/user", produces = MediaType.APPLICATION_JSON_VALUE)
@Api(tags = "用户管理") 
public class User {

    @GetMapping
    @ApiOperation(value = "分页查询")
    public String page(){
        return "嘿嘿";
    }

    @GetMapping("/haha")
    @ApiOperation(value = "分页查询2")
    public List<UserEntity> getData(){
        List<UserEntity> list = new ArrayList<>();
        list.add(new UserEntity().setName("花花").setSex("男"));
        list.add(new UserEntity().setName("小王").setSex("女"));
        return list;
    }

}

4.打开网址http://localhost:8080/swagger-ui/index.html即可看到如下接口文档界面
其中ip和端口设置为你自己的即可

5.yaml配置，如果上生产了需要禁用swagger，则改为false即可：

#是否激活 swagger true or false
swagger:
  enable: true

2.配置Knife4j（强烈推荐）

Knife4j使用文档

友情提示

1、目前已经发行的Knife4j版本，Knife4j本身已经引入了springfox，开发者在使用时不用再单独引入Springfox的具体版本，否额会导致版本冲突。另外在网关层聚合(例如gateway)时，必须禁用Knife4j的增强模式

2、使用Knife4j2.0.6及以上的版本，Spring Boot的版本必须大于等于2.2.x

3、微服务聚合组件Knife4jAggregation强势发布，聚合OpenAPI文档太简单了,详见文档

4、Knife4j独立运行版本Knife4jAggregationDesktop强势发布,使用Knife4j渲染OpenAPI文档很简单,详见文档

1.pom.xml加入依赖

<!--跟swagger类似，支持springboot 2.2.x 以上版本-->
 <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.2</version>
 </dependency>

2.配置文件

package com.example.demo.config;

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

@Configuration
@EnableSwagger2WebMvc // 貌似被弃用，可以替换为@EnableSwagger2
public class Knife4jConfiguration {

	@Value("${swagger.enable}")
    private Boolean enable;

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

3.编写你的controller

@RestController
@RequestMapping(value = "/api/v2/user", produces = MediaType.APPLICATION_JSON_VALUE)
@Api(tags = "用户管理")
public class User {

    @GetMapping
    @ApiOperation(value = "分页查询")
    public String page(){
        return "嘿嘿";
    }

    @GetMapping("/haha")
    @ApiOperation(value = "分页查询2")
    public List<UserEntity> getData(){
        List<UserEntity> list = new ArrayList<>();
        list.add(new UserEntity().setName("花花").setSex("男"));
        list.add(new UserEntity().setName("小王").setSex("女"));
        return list;
    }
}

4.访问http://localhost:8080/doc.html#/home，ip和端口改为你自己的，接口文档界面如下

5.yaml配置，如果上生产了需要禁用swagger，则改为false即可：

#是否激活 swagger true or false
swagger:
  enable: true

3.注解使用

• @Api：用在controller类上，描述API接口，例：

@Api(tags = "用户管理")

• @ApiOperation：用在controller的方法上，例：

@ApiOperation(value = "分页查询")

• @ApiModel：用在实体类上
• @ApiModelProperty：描述对象属性

@Data
@Accessors(chain = true)// 这个是lombok注解
@ApiModel
public class UserEntity {

    @ApiModelProperty("名称")
    private String name;
    @ApiModelProperty("性别")
    private String sex;
}

以下三个注解实际上很少用

• @ApiImplicitParams：描述接口参数
• @ApiResponses：描述接口响应
• @ApiIgnore：忽略不显示接口参数