基于Spring Boot项目的Swagger2

一：pom文件中引入依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

二：编写配置类

package com.xiaomm.springswagger.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.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {
    
    /**
     * apis()表示我们需要扫描的接口
     *      RequestHandlerSelectors.withClassAnnotation(Api.class)：基于@Api注解，仅扫描待@Api注解的接口类
     *      RequestHandlerSelectors.basePackage("com.xiaomm.springswagger.controller")：基于包路径，扫描某个包下的接口类
     */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 基于包路径
                .apis(RequestHandlerSelectors.basePackage("com.xiaomm.springswagger.controller"))
                // 基于注解-@Api
                // .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Welcome come to BEIJING")
                .description("更多请关注https://blog.csdn.net/lyhhyl0205")
                .termsOfServiceUrl("https://blog.csdn.net/lyhhyl0205")
                // .contact("sunf")
                .version("1.0")
                .build();
    }

}

三：接口信息

package com.xiaomm.springswagger.controller;

import io.swagger.annotations.Api;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 此处用@Api与配置类RequestHandlerSelectors.withClassAnnotation(Api.class)对应
 */
@Api(description = "用户控制器")
@RestController
@RequestMapping(value = "/user")
public class UserController {

    @GetMapping(value = "/getUserById")
    public String getUser(Integer id){
        return "user: " + id;
    }

    @PostMapping(value = "/savUser")
    public String savUser(Integer id){
        return "save-ok: " + id;
    }

    @PutMapping(value = "/updateUserById")
    public String updateUser(Integer id){
        return "update ok: " + id;
    }

    @DeleteMapping(value = "/deleteUserById")
    public String deleteUser(Integer id){
        return "delete ok: " + id;
    }
}

四：启动服务，访问路径http://localhost:9999/swagger-ui.html#/，具体路径视情况而定

五：相关注解

@Api： 描述 Controller
@ApiIgnore： 忽略该 Controller，指不对当前类做扫描
@ApiOperation： 描述 Controller类中的 method接口
@ApiParam： 单个参数描述，与 @ApiImplicitParam不同的是，他是写在参数左侧的。如（ @ApiParam(name="username",value="用户名")Stringusername）
@ApiModel： 描述 POJO对象
@ApiProperty： 描述 POJO对象中的属性值
@ApiImplicitParam： 描述单个入参信息
@ApiImplicitParams： 描述多个入参信息
@ApiResponse： 描述单个出参信息
@ApiResponses： 描述多个出参信息
@ApiError： 接口错误所返回的信息

注意：遇到的问题

Jar包冲突，启动报错。

com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google/common/collect/FluentIterable;

解决办法：重新配置pom文件

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
    <exclusions>
        <exclusion>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
    <exclusions>
        <exclusion>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
        </exclusion>
     </exclusions>
</dependency>
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>20.0</version>
</dependency>