SpringBoot集成Swagger2

作为一个后端开发菜鸟，难的又不会，简单的又不想写，没救了

昨天get到一个有效的偷懒方式——Swagger2，自动通过代码和注解自动生成文档的方法。开始动手吧！

1.引用对应的Maven包

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

2.写配置类

package com.zby.zby521.swagger2;
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;

/**
 *
 * @author zby
 * @create 2019
 */
@EnableSwagger2
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.zby.zby521"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("接口文档")
                //版本号
                .version("1.0")
                //描述
                .description("这是一个比较粗糙的文档，请将就一点点")
                .build();
    }
}

 3.随便写一个Controller类测试一下

package com.zby.zby521.swagger2;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;

/**
 *
 * @author zby
 * @create 2019
 */
@RestController
@RequestMapping("/demo")
public class UserController {

    @ApiOperation(value="创建用户", notes="根据User对象创建用户")
    @ApiImplicitParams({
            @ApiImplicitParam(dataType = "java.lang.Long", name = "id", value = "id", required = true, paramType = "path"),
            @ApiImplicitParam(dataType = "User", name = "user", value = "用户信息", required = true)
    })
    @RequestMapping(value = "/user/{id}",method = RequestMethod.POST)
    public HashMap insert(@PathVariable Long id, @RequestBody HashMap user){

        System.out.println("id:"+id+", user:"+user);
        user.put("id",1);

        return user;
    }

    @ApiOperation(value="获取指定id用户详细信息", notes="根据user的id来获取用户详细信息")
    @ApiImplicitParam(name = "id",value = "用户id", dataType = "String", paramType = "path")
    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    public HashMap getUser(@PathVariable Long id){

        HashMap user = new LinkedHashMap();
        user.put("id",id);
        user.put("username","zby");
        user.put("password","12345");
        return user;
    }

    @ApiOperation(value="获取所有用户详细信息", notes="获取用户列表信息")
    @RequestMapping(value = "/users", method = RequestMethod.GET)
    public List<HashMap> getUserList(){

        List<HashMap> list = new ArrayList<>();
        HashMap user = new LinkedHashMap();
        user.put("id",1);
        user.put("username","zby");
        user.put("password","12345");

        list.add(user);

        return list;
    }

    @ApiIgnore
    @ApiOperation(value="删除指定id用户", notes="根据id来删除用户信息")
    @ApiImplicitParam(name = "id",value = "用户id", dataType = "java.lang.Long", paramType = "path")
    @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
    public String delete(@PathVariable Long id){
        System.out.println("delete user:"+id);
        return "OK";
    }
}

一般写完这些，然后启动SpringBoot就可以生成一个swagger-ui.html，然后就差访问了，一般都是http://localhost:8080/swagger-ui.html，如果不是就看看配置文件的端口什么的对比一下。swagger深入了解请点击以下网址：

https://www.ibm.com/developerworks/cn/java/j-using-swagger-in-a-spring-boot-project/index.html