springboot集成swagger2

简述
swagger2是一个非常好的api框架，提供了在线查看文档，和在线测试的功能

引入依赖

 <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

创建配置类

package com.rb.fmea.config;

/**
 * @version v1.0
 * @ClassName: Swagger2
 * @Description: TODO
 * @Author: yyk
 * @Date: 2020/5/16 10:09
 */

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



/**
 * @Author yyk
 * @Description //TODO swagger2配置类
 * @Date 2020/5/16 17:33
 * @Param
 * @return
 **/
 //Configuration注解表示是一个配置类，EnableSwagger2表示开启swagger
@Configuration
@EnableSwagger2
public class Swagger2 Config{
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.rb.fmea.controller"))
                .paths(PathSelectors.any())
                .build();
//        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot 使用 Swagger2")
                //创建人
                .contact(new Contact("yyk", "", ""))
                //版本号
                .version("1.0")
                //描述
                .description("")
                .build();
    }
}

swagger相关注解
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiParamImplicitL：一个请求参数
@ApiParamsImplicit 多个请求参数

在controller应用

package com.rb.fmea.controller;

import com.rb.fmea.dao.UserMapper;
import com.rb.fmea.entities.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;


import java.util.UUID;

/**
 * @version v1.0
 * @ClassName: UserController
 * @Description: TODO
 * @Author: yyk
 * @Date: 2020/5/16 15:48
 */
@Api(description = "用户操作接口")
@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserMapper userMapper;

    @RequestMapping(value = "/add",method = RequestMethod.POST)
    //@ApiImplicitParam(paramType = "query", required = true, dataType = "Integer")
    @ApiOperation(value = "添加用户",notes = "添加用户")
    public String add(String name,String password){
        try {
            int insert = userMapper.insert(new User(name, password));
            System.out.println(insert);
            return "成功";
        } catch (Exception e) {
            return e.getMessage();
        }
    }


    @RequestMapping(value = "delete",method = RequestMethod.DELETE)
    @ApiOperation(value = "删除用户",notes = "删除用户")
    public String delete(){
        try {
            int a=1/0;
            System.out.println(UUID.randomUUID());
            return "成功";
        } catch (Exception e) {
            return e.getMessage();
        }
    }
    @RequestMapping(value = "update",method = RequestMethod.POST)
    @ApiOperation(value = "修改用户",notes = "修改用户")
    public String update(){
        try {
            System.out.println(UUID.randomUUID());
            return "成功";
        } catch (Exception e) {
            return e.getMessage();
        }
    }

    @RequestMapping(value = "select",method = RequestMethod.GET)
    @ApiOperation(value = "查找用户",notes = "查找用户")
    public String select(){
        try {
            System.out.println(UUID.randomUUID());
            return "成功";
        } catch (Exception e) {
            return e.getMessage();
        }
    }


}

swagger页面

参考文档：http://www.xiaochenboss.cn/article_detail/1582639380977