SpringBoot集成Swagger2

前言

本章节主要介绍SpringBoot项目集成Swagger2的一些相关知识，包括集成版本、依赖、集成方式、以及简单的使用。官方提供的SwaggerUI太low，本篇集成了knife4j，在可视化方面有了大大的提示，操作更加人性化。

一、Swagger是什么？

Swagger是一个restful规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的 工具。在后端服务定义好参数格式以及方法，启动服务后网页即可访问接口信息文档 ，并且在网页端可进行接口测试。Swagger让部署管理和使用功能强大的API变得非常简单。

二、集成步骤

1.依赖引入

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.1</version>
        <relativePath/> <!-- lookup parent from repository -->
    	</parent>

   	 <properties>
        <java.version>1.8</java.version>
   	 </properties>


 	<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-ui</artifactId>
            <version>3.0.3</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>

2.代码配置

config初始化配置，主要用于初始化swagger以及定义基本信息basePackage为扫描controller的路径
其他信息按照自己想法定义即可

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig{
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
		//扫描的包路径
                .apis(RequestHandlerSelectors.basePackage("com.example.owladmin.controller"))
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("OwlAdmin接口文档")
                .description("OwlAdmin接口文档")
                .contact(new Contact("owlsama","http://blog.owlsama.com","ybzhang1013@gmial.com"))
                .version("1.0.0")
                .build();
    }
}

3.Controller层代码

// 定义模块名称
@Api(tags = “HELLO控制接口”)
// value 接口标签名称 notes 接口描述
@ApiOperation(value = “用户访问信息”, notes = “用于收集用户访问的IP 位置 天气等”)

import com.example.zimuge.AjaxResponse;
import com.example.zimuge.config.HttpTemplate;
import com.example.zimuge.model.LombokPOJO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;

@RestController
@Slf4j
@Api(tags = "HELLO控制接口")
public class HelloController {
    // 用户访问信息获取
    //    value 接口标签名称   notes 接口描述
    @ApiOperation(value = "用户访问信息", notes = "用于收集用户访问的IP 位置 天气等")
    @GetMapping(value = "/userinfo")
    public AjaxResponse userinfo() {
        Object res = HttpTemplate.httpGet("https://api.vvhan.com/api/visitor.info");
        return AjaxResponse.success(res, "查询成功！");
    }

}

4.访问路径

http://localhost:port/doc.html#/home

5.效果展示

总结

以上就是SpringBoot集成swagger内容。需要注意的是，不同版本会导致swagger集成后网页访问报错，参数定义不一致也会有同样的问题。